Skip to content

Segment - Count

GET
/segments/v2/{bucket}/segment/{uid}/count

The count and description of the segment

bucket
required

The bucket (client) name

string
Example
example
resource_type
required

The type of resource, usually the second element in the URI e.g person, organisation, member, payment

string
Example
person
uid
required

Usually the final element in the URI, an alphanumeric unique identifier

string
Example
6305f074683e800f3abe809e

The count and description of the segment

object
count
integer
description
string
segment

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string
Example
/example/person/6305f074683e800f3abe809e/

A standard error message

object
description

A human readable description of the error

string
error

A concise error message

string
type

A machine readable error type

string

Authentication error