Attributions Examples

Attributions for an advertisable

GET /uhura/v1/attributions/advertisable

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/attributions/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": {
      "view_throughs": 103,
      "click_throughs": 103,
      "view_revenue": 10.19,
      "click_revenue": 1.05
    },
    "entity": [
      {
        "entity": "MY_ADVERTISABLE_EID",
        "view_throughs": 103,
        "click_throughs": 103,
        "view_revenue": 10.19,
        "click_revenue": 1.05
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "view_throughs": 100,
        "click_throughs": 100,
        "view_revenue": 9.82,
        "click_revenue": 0.73
      },
      {
        "date": "2015-11-02",
        "view_throughs": 3,
        "click_throughs": 3,
        "view_revenue": 0.37,
        "click_revenue": 0.32
      }
    ]
  }
}

Attributions for an AdGroup

GET /uhura/v1/attributions/adgroup

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/attributions/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",
        "view_throughs": 103,
        "click_throughs": 103,
        "view_revenue": 10.19,
        "click_revenue": 105.0
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "view_throughs": 12,
        "click_throughs": 47,
        "view_revenue": 9.82,
        "click_revenue": 23.0
      },
      {
        "date": "2015-11-02",
        "view_throughs": 91,
        "click_throughs": 56,
        "view_revenue": 0.37,
        "click_revenue": 82.0
      }
    ]
  }
}

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/attributions/adgroup?apikey=MYAPIKEY&breakdowns=summary,entity,date&advertisable_eid=MY_ADVERTISABLE_EID&past_days=2"

Response:

{
  "results": {
    "summary": {
      "view_throughs": 0,
      "click_throughs": 0,
      "view_revenue": 0.0,
      "click_revenue": 0.0
    },
    "entity": [],
    "date": [
      {
        "date": "2015-11-01",
        "view_throughs": 0,
        "click_throughs": 0,
        "view_revenue": 0,
        "click_revenue": 0.0
      },
      {
        "date": "2015-11-02",
        "view_throughs": 0,
        "click_throughs": 0,
        "view_revenue": 0.0,
        "click_revenue": 0.0
      }
    ]
  }
}

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/attributions/adgroup?apikey=MYAPIKEY&breakdowns=entity,date&advertisable_eid=MY_ADVERTISABLE_EID&adgroup_eids=MY_ADGROUP_EID&past_days=2"

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_ADGROUP_EID",
        "view_throughs": 0,
        "click_throughs": 0,
        "view_revenue": 0.0,
        "click_revenue": 0.0
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "view_throughs": 0,
        "click_throughs": 0,
        "view_revenue": 0,
        "click_revenue": 0.0
      },
      {
        "date": "2015-11-02",
        "view_throughs": 0,
        "click_throughs": 0,
        "view_revenue": 0.0,
        "click_revenue": 0.0
      }
    ]
  }
}

Attributions for an advertisement

GET /uhura/v1/attributions/ad

Request:

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

Response:

{
  "results": {
    "entity": [
      {
        "entity": "MY_AD_EID",
        "view_throughs": 103,
        "click_throughs": 103,
        "view_revenue": 10.19,
        "click_revenue": 105.0
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "view_throughs": 12,
        "click_throughs": 47,
        "view_revenue": 9.82,
        "click_revenue": 23.0
      },
      {
        "date": "2015-11-02",
        "view_throughs": 91,
        "click_throughs": 56,
        "view_revenue": 0.37,
        "click_revenue": 82.0
      }
    ]
  }
}

Attributions for a segment

GET /uhura/v1/attributions/segment

Request:

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

Response:

{
  "results": {
    "summary": {
      "view_throughs": 206,
      "click_throughs": 206,
      "view_revenue": 20.38,
      "click_revenue": 2.1
    },
    "entity": [
      {
        "entity": "MY_SEGMENT_EID_1",
        "view_throughs": 103,
        "click_throughs": 103,
        "view_revenue": 10.19,
        "click_revenue": 1.05
      },
      {
        "entity": "MY_SEGMENT_EID_2",
        "view_throughs": 103,
        "click_throughs": 103,
        "view_revenue": 10.19,
        "click_revenue": 1.05
      },
      {
        "entity": "MY_SEGMENT_EID_3",
        "view_throughs": 0,
        "click_throughs": 0,
        "view_revenue": 0.0,
        "click_revenue": 0.0
      }
    ],
    "date": [
      {
        "date": "2015-11-01",
        "view_throughs": 100,
        "click_throughs": 106,
        "view_revenue": 9.82,
        "click_revenue": 0.73
      },
      {
        "date": "2015-11-02",
        "view_throughs": 106,
        "click_throughs": 100,
        "view_revenue": 10.56,
        "click_revenue": 1.37
      }
    ]
  }
}

Granular attributions

GET /uhura/v1/combined-granular-attributions

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/combined-granular-attributions?apikey=MYAPIKEY&advertisable_eid=MY_ADVERTISABLE_EID&start_date=2018-09-01&end_date=2018-09-07"

Response:

{
  "results": [
      {
         "conversion_guid" : "162050a6-45c5-9b1f-3cad-57c3a458d66c",
         "attributed_ratio" : 1,
         "last_touch_time" : "2018-08-30 20:56:33",
         "ad_eid" : "AASZ54QCYBC3JLSJZNCP4Q",
         "conversion_type" : "View through",
         "product_type" : "rt",
         "first_touch_to_conversion" : 0,
         "referrer" : "/signup/confirmation",
         "attributed_value" : 0,
         "segment_eid" : "AAAOZVLAQ5FM3OJ2GAZXJX",
         "city" : "Kelowna",
         "first_touch_time" : "2018-08-02 20:31:02",
         "is_last_touch_attribution" : true,
         "height" : 600,
         "conversion_value" : 0,
         "external_data" : null,
         "attribution_model" : "AdRoll Default",
         "country" : "Canada",
         "attribution_credit" : "Attributed",
         "adgroup_eid" : "AAOSBASYGJHJ5J7BZFS3WO",
         "campaign_eid" : "AALNFFEEKZC3BDVOSA24KY",
         "cookie" : null,
         "width" : 300,
         "touchpoint_time" : "2018-08-30 20:56:33",
         "conversion_time" : "2018-09-01 00:03:16",
         "device_id_type" : "desktop"
      },
      {
         "height" : 90,
         "conversion_value" : 0,
         "attribution_model" : "AdRoll Default",
         "external_data" : null,
         "first_touch_time" : "2018-08-31 18:25:05",
         "is_last_touch_attribution" : true,
         "adgroup_eid" : "AAD4CUKYCRAETGMVEWCV7F",
         "campaign_eid" : "AATSECFVBZA6RGMRZLJOBB",
         "attribution_credit" : "Attributed",
         "country" : "United States",
         "width" : 728,
         "cookie" : null,
         "touchpoint_time" : "2018-08-31 18:33:42",
         "device_id_type" : "desktop",
         "conversion_time" : "2018-09-01 00:58:40",
         "attributed_ratio" : 1,
         "last_touch_time" : "2018-08-31 18:33:42",
         "conversion_guid" : "146e4a80-7589-3cf5-972e-db34afa05178",
         "ad_eid" : "AAHAPRKZXZFZ7NKCWIMB4F",
         "product_type" : "rt",
         "conversion_type" : "View through",
         "referrer" : "/signup/confirmation",
         "first_touch_to_conversion" : 0,
         "segment_eid" : "AAAOZVLAQ5FM3OJ2GAZXJX",
         "city" : "Cannon Falls",
         "attributed_value" : 0
      },
      ...
  ]
}

Attribution CSV export

GET /uhura/v1/attributions/export

Request:

curl --user dev@example.com:my-password-is-great \
"https://services.adroll.com/uhura/v1/attributions/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"
date,advertisable_eid,adgroup_eid,vt2,ct2,vt2_revenue,ct2_revenue
2015-11-01,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_1,23,88,43.74,89.57
2015-11-01,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_2,93,54,78.66,74.29
2015-11-02,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_1,34,29,69.37,42.12
2015-11-02,MY_ADVERTISABLE_EID,MY_ADGROUP_EID_2,11,8,12.00,39.78