Deliveries Examples¶

Warning

The Reporting API will be retired at the end of February 2022. Please migrate to the GraphQL Reporting API by following the migration guide.

Examples on this page:

Deliveries for an advertisable
Deliveries for a campaign
Deliveries for an AdGroup
Deliveries for advertisement
Deliveries for a domain
Domain deliveries for an AdGroup
Domain deliveries for an advertisement
Deliveries CSV export

Deliveries for an advertisable ¶

GET /uhura/v1/deliveries/advertisable

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/advertisable?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "MY_ADVERTISABLE_EID",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Deliveries for a campaign ¶

GET /uhura/v1/deliveries/campaign

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/campaign?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&campaign_eids=MY_CAMPAIGN_EID&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_CAMPAIGN_EID",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Deliveries for an AdGroup ¶

GET /uhura/v1/deliveries/adgroup

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/adgroup?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&adgroup_eids=MY_ADGROUP_EID&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_ADGROUP_EID",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/adgroup?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_ADGROUP_EID",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      },
      {
        "entity": "MY_ADGROUP_EID_2",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      },
      {
        "entity": "adgroup3",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 1296,
        "clicks": 834,
        "cost": 63.6
      },
      {
        "date": "2015-11-02",
        "impressions": 1071,
        "clicks": 534,
        "cost": 82.44
      }
    ]
  }
}

Deliveries for advertisement ¶

GET /uhura/v1/deliveries/ad

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/ad?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&adgroup_eids=MY_AD_EID&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_AD_EID",
        "impressions": 789,
        "clicks": 456,
        "cost": 48.68
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/ad?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&past_days=2"

Response:

{
  "results": {
    "entity": [],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Deliveries for a domain ¶

GET /uhura/v1/deliveries/domain

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/domain?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "domain1.com",
        "impressions": 263,
        "clicks": 152,
        "cost": 16.22
      },
      {
        "entity": "domain2.com",
        "impressions": 263,
        "clicks": 152,
        "cost": 16.22
      },
      {
        "entity": "domain3.com",
        "impressions": 263,
        "clicks": 152,
        "cost": 16.22
      },
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/domain?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&domain=domain1.com,domain2.com&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "domain1.com",
        "impressions": 394,
        "clicks": 228,
        "cost": 24.34
      },
      {
        "entity": "domain2.com",
        "impressions": 395,
        "clicks": 228,
        "cost": 24.34
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Domain deliveries for an AdGroup ¶

GET /uhura/v1/deliveries/domain/adgroup

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/domain/adgroup?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&domain=domain1.com,domain2.com&adgroup_eids=MY_ADGROUP_EID_1,MY_ADGROUP_EID_2&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "domain1.com,MY_ADGROUP_EID_1",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain2.com,MY_ADGROUP_EID_1",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain1.com,MY_ADGROUP_EID_2",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain2.com,MY_ADGROUP_EID_2",
        "impressions": 198,
        "clicks": 114,
        "cost": 12.17
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/domain/adgroup?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&adgroup_eids=MY_ADGROUP_EID&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "domain1.com,MY_ADGROUP_EID",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain2.com,MY_ADGROUP_EID",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain3.com,MY_ADGROUP_EID",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain4.com,MY_ADGROUP_EID",
        "impressions": 198,
        "clicks": 114,
        "cost": 12.17
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Domain deliveries for an advertisement ¶

GET /uhura/v1/deliveries/domain/ad

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/domain/ad?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&domain=domain1.com,domain2.com&ad_eids=MY_AD_EID_1,MY_AD_EID_2&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "domain1.com,MY_AD_EID_1",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain1.com,MY_AD_EID_2",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain2.com,MY_AD_EID_1",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain2.com,MY_AD_EID_2",
        "impressions": 198,
        "clicks": 114,
        "cost": 12.17
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/domain/ad?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&ad_eids=MY_AD_EID&currency=CAD&start_date=2015-11-01&end_date=2015-11-03"

Response:

{
  "results": {
    "summary": {
      "impressions": 789,
      "clicks": 456,
      "cost": 48.68
    }
    "entity": [
      {
        "entity": "domain1.com,MY_AD_EID",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain2.com,MY_AD_EID",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain3.com,MY_AD_EID",
        "impressions": 197,
        "clicks": 114,
        "cost": 12.17
      },
      {
        "entity": "domain4.com,MY_AD_EID",
        "impressions": 198,
        "clicks": 114,
        "cost": 12.17
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "impressions": 432,
        "clicks": 278,
        "cost": 21.2
      },
      {
        "date": "2015-11-02",
        "impressions": 357,
        "clicks": 178,
        "cost": 27.48
      }
    ]
  }
}

Deliveries CSV export ¶

GET /uhura/v1/deliveries/export

Request:

curl -H 'Authorization: Token YOUR_TOKEN' \
"https://services.adroll.com/uhura/v1/deliveries/export?apikey=MYAPIKEY&advertisable_eid=MY_ADVERTISABLE_EID&adgroup_eids=MY_ADGROUP_EID_1,MY_ADGROUP_EID_2&start_date=2015-11-01&end_date=2015-11-03"

Response:

#date,advertisable_eid,adgroup_eid,imp,cli,cost
2015-11-01,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_1,23,88,89.57
2015-11-01,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_2,93,54,74.29
2015-11-02,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_1,34,29,42.12
2015-11-02,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_2,11,8,39.78