User Lists API Examples

Examples on this page

Retrieve the size of a segment

To retrieve a summary of the size of a segment, you can use the GET /sigma/api/v1/userlists/segment endpoint.

Specify:

advertisable_eid

Advertisable that owns the segment

segment_eids

Segment that you want to query

breakdowns

How to group the data, for example summary or date

start_date

First day to retreive data for

end_date

Last day to retrieve data for

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/sigma/api/v1/userlists/segment?apikey=MYAPIKEY&advertisable_eid=MY_ADVERTISABLE_EID&segment_eids=MY_SEGMENT_EID&breakdowns=summary&start_date=2019-08-21&end_date=2019-09-26"

Response:

{
  "results": {
    "summary": {
      "current_visitors": 1613519,
      "current_visitors_in_date_range": 781266,
      "new_visitors": 781266,
      "total_visitors": 781266
    }
  }
}