Analytics and logs

Get top segments

Get top segments by contact count.

get/orgs/analytics/contacts/top-segments

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/analytics/contacts/top-segments
  • Auth: HTTP bearer

Query parameters

from_datestring date-time nullable

Start of the range (ISO 8601 date). Omit for all time.

to_datestring date-time nullable

End of the range (ISO 8601 date). Omit for up to now.

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

segment_idstring required
namestring required
color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral'

Accent color, by name

countnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.