User List Examples

User lists by advertisable

GET /uhura/v1/userlists/advertisable

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/userlists/advertisable?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&duration=90&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_ADVERTISABLE_EID",
        "90_days": {
          "total_visitors": 123,
          "new_visitors": 44,
          "current_visitors": 12
        }
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "new_visitors": 4
      },
      {
        "date": "2015-11-02",
        "new_visitors": 5
      }
    ]
  }
}

User lists by segment

GET /uhura/v1/userlists/segment

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/userlists/segment?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&segment_eids=MY_SEGMENT_EID_1,MY_SEGMENT_EID_2&durations=90,60,40&excluded_segment_eids=MY_EXCLUDED_SEGMENT_EID_1,MY_EXCLUDED_SEGMENT_EID_2&excluded_durations=45,20&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "total_visitors": 93,
      "new_visitors": 27,
      "current_visitors": 13
    },
    "entity": [
      {
        "entity": "MY_SEGMENT_EID_1",
        "90_days": {
          "total_visitors": 123,
          "new_visitors": 44,
          "current_visitors": 12
        }
      },
      {
        "entity": "MY_SEGMENT_EID_2",
        "60_days": {
          "total_visitors": 44,
          "new_visitors": 43,
          "current_visitors": 22
        },
        "40_days": {
          "total_visitors": 32,
          "new_visitors": 27,
          "current_visitors": 33
        }
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "new_visitors": 4
      },
      {
        "date": "2015-11-02",
        "new_visitors": 5
      }
    ]
  }
}

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/userlists/segment?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&segment_eids=MY_SEGMENT_EID_1,MY_SEGMENT_EID_2&durations=90,90&count_emails=true&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "total_visitors": 93,
      "new_visitors": 27,
      "current_visitors": 13
    },
    "entity": [
      {
        "entity": "MY_SEGMENT_EID_1",
        "90_days": {
          "total_visitors": 123,
          "new_visitors": 44,
          "current_visitors": 12
        }
      },
      {
        "entity": "MY_SEGMENT_EID_2",
        "90_days": {
          "total_visitors": 53,
          "new_visitors": 4,
          "current_visitors": 16
        }
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "new_visitors": 15
      },
      {
        "date": "2015-11-02",
        "new_visitors": 16
      }
    ]
  }
}

User lists by AdGroup

GET /uhura/v1/userlists/adgroup

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/userlists/adgroup?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&adgroup_eids=MY_ADGROUP_EID_1,MY_ADGROUP_EID_2&durations=90,90&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "total_visitors": 93,
      "new_visitors": 27,
      "current_visitors": 13
    },
    "entity": [
      {
        "entity": "MY_ADGROUP_EID_1",
        "90_days": {
          "total_visitors": 123,
          "new_visitors": 44,
          "current_visitors": 12
        }
      },
      {
        "entity": "MY_ADGROUP_EID_2",
        "90_days": {
          "total_visitors": 53,
          "new_visitors": 4,
          "current_visitors": 16
        }
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "new_visitors": 4
      },
      {
        "date": "2015-11-02",
        "new_visitors": 5
      }
    ]
  }
}

User lists by advertisement

GET /uhura/v1/userlists/ad

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/userlists/ad?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&ad_eids=MY_AD_EID_1,MY_AD_EID_2&durations=90,90&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "total_visitors": 93,
      "new_visitors": 27,
      "current_visitors": 13
    },
    "entity": [
      {
        "entity": "MY_AD_EID_1",
        "90_days": {
          "total_visitors": 123,
          "new_visitors": 44,
          "current_visitors": 12
        }
      },
      {
        "entity": "MY_AD_EID_2",
        "90_days": {
          "total_visitors": 53,
          "new_visitors": 4,
          "current_visitors": 16
        }
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "new_visitors": 4
      },
      {
        "date": "2015-11-02",
        "new_visitors": 5
      }
    ]
  }
}