Statistics can be requested by day or in total. The delta total can be used to get e.g. per hour statistics.

Contact your Delta Projects representative to get your mediaAgencyId!

Activity Statistics

Description: Retrieve activity statistics
Verb: GET
Path:/api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>/statistics

Request Parameters

ParameterTypeRequiredDescriptionExample
mediaAgencyIdPathYesId of media agency86b35325-794c-11e4-8425-daf437376f87
clientIdPathYesId of client86b35326-794c-11e4-8425-daf437376f87
campaignIdPathYesId of campaign. Must be "default" in v1.default
activityIdPathYesId of activity86b35327-794c-11e4-8425-daf437376f87
intervalQueryNoStatistics date interval (default: activity flight)2014-01-01/2014-01-10
group_byQueryNoGrouping (default: "bidding_plan")"format"
granularityQueryNoGranularity (default: "none")"day"
sort_orderQueryNoThe sorting order of Entries - ASC(default) or DESCDESC
limitQueryNoNumber of Entries to limit the response to10
apikeyQueryYesAPI key for authentication and authorizationsecretkey123

Available groupings:

  • "bidding_plan" -- Bidding Plan
  • "bidding_platform" -- Inventory Channel
  • "format" -- Creative dimensions
  • "site" -- Site

Available granularities:

  • "none" -- Total during period
  • "day" -- Per day, during period

Response JSON body

ParameterParameter TypeDescriptionExample
top levelArray of GroupGroupSee below

Group Object

ParameterParameter TypeDescriptionExample
nameStringName of group"Example Inventory Channel 1"
idStringId of group (only applicable for bidding_plan"86b35328-794c-11e4-8425-daf437376f87"
entriesArray of EntryEntries within groupSee below

id is only included when group_by is bidding_plan.

Entry object [entry-object]

ParameterParameter TypeDescriptionExample
bidsIntegerBids1000
impressionsIntegerImpressions1000
viewable_impressionsDoubleViewable Impressions factor0.6652360515021459
clicksIntegerClicks50
vt_ordersIntegerVT Orders4
ct_ordersIntegerCT Orders1
costDoubleCost in account currency2.5
range_beginISO8601 TimestampStatistics date start"2014-01-01T00:00:00.000Z"
range_endISO8601 TimestampStatistics date end"2014-01-01T23:59:59.999Z"

viewable_impressions is only included if sufficient data is available.

range_end set to 2014-01-01 will be read as 2014-01-01T00:00:00.000Z.

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87/statistics?apikey=secret123&interval=2014-01-01/2014-01-03&granularity=day&group_by=bidding_platform

Example Response

[
  {
    "entries": [
      {
        "bids": 1000,
        "clicks": 50,
        "cost": 2.5,
        "ct_orders": 1,
        "impressions": 1000,
        "range_begin": "2014-01-01T00:00:00.000Z",
        "range_end": "2014-01-01T23:59:59.999Z",
        "viewable_impressions": 0.6652360515021459,
        "vt_orders": 4
      },
      {
        "bids": 1000,
        "clicks": 50,
        "cost": 2.5,
        "ct_orders": 1,
        "impressions": 1000,
        "range_begin": "2014-01-02T00:00:00.000Z",
        "range_end": "2014-01-02T23:59:59.999Z",
        "viewable_impressions": 0.6652360515021459,
        "vt_orders": 4
      },
      {
        "bids": 1000,
        "clicks": 50,
        "cost": 2.5,
        "ct_orders": 1,
        "impressions": 1000,
        "range_begin": "2014-01-03T00:00:00.000Z",
        "range_end": "2014-01-03T23:59:59.999Z",
        "viewable_impressions": 0.6652360515021459,
        "vt_orders": 4
      }
    ],
    "name": "Example Inventory Channel 1",
    "id": "86b35328-794c-11e4-8425-daf437376f87"
  },
  {
    "entries": [
      {
        "bids": 1000,
        "clicks": 50,
        "cost": 2.5,
        "ct_orders": 1,
        "impressions": 1000,
        "range_begin": "2014-01-01T00:00:00.000Z",
        "range_end": "2014-01-01T23:59:59.999Z",
        "viewable_impressions": 0.6652360515021459,
        "vt_orders": 4
      },
      {
        "bids": 1000,
        "clicks": 50,
        "cost": 2.5,
        "ct_orders": 1,
        "impressions": 1000,
        "range_begin": "2014-01-02T00:00:00.000Z",
        "range_end": "2014-01-02T23:59:59.999Z",
        "viewable_impressions": 0.6652360515021459,
        "vt_orders": 4
      },
      {
        "bids": 1000,
        "clicks": 50,
        "cost": 2.5,
        "ct_orders": 1,
        "impressions": 1000,
        "range_begin": "2014-01-03T00:00:00.000Z",
        "range_end": "2014-01-03T23:59:59.999Z",
        "viewable_impressions": 0.6652360515021459,
        "vt_orders": 4
      }
    ],
    "name": "Example Inventory Channel 2",
    "id": "86b35328-794c-11e4-8425-daf437376f88"
  }
]

Live Activity Statistics Summary

Description: Retrieve live activity statistics summary
Verb: GET
Path:/api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>/live_statistics_summary

Request Parameters

ParameterTypeRequiredDescriptionExample
mediaAgencyIdPathYesId of media agency86b35325-794c-11e4-8425-daf437376f87
clientIdPathYesId of client86b35326-794c-11e4-8425-daf437376f87
campaignIdPathYesId of campaign. Must be "default" in v1default
activityIdPathYesId of activity86b35327-794c-11e4-8425-daf437376f87
apikeyQueryYesAPI key for authentication and authorizationsecretkey123

Response JSON body

ParameterParameter TypeDescriptionExample
nameStringName of activity"Example Campaign"
idStringId of activity"86b35328-794c-11e4-8425-daf437376f87"
bidsIntegerBids78954
impressionsIntegerImpressions42007
clicksIntegerClicks124
reachIntegerReach32811
costDoubleCost59.51
currencyISO4217 CurrencyCost currency code"EUR"
activity_beginISO8601 TimestampStatistics date start"2017-02-01T00:00:00.000Z"
activity_endISO8601 TimestampStatistics date end"2017-05-01T23:59:59.999Z"
generated_atISO8601 TimestampReport creation time"2017-03-25T14:01:31.056Z"

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87/live_statistics_summary?apikey=secret123

Example Response

{
  "name": "Example Campaign",
  "id": "86b35328-794c-11e4-8425-daf437376f87",
  "bids": 78954,
  "impressions": 42007,
  "clicks": 124,
  "reach": 32811,
  "cost": 594.17251,
  "currency": "SEK",
  "activity_begin": "2017-02-01T00:00:00.000Z",
  "activity_end": "2017-05-01T23:59:59.999Z",
  "generated_at": "2017-03-25T14:01:31.056Z"
}

Live Activity Statistics

Description: Retrieve live activity statistics
Verb: GET
Path:/api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>/live_statistics

Request Parameters

ParameterTypeRequiredDescriptionExample
mediaAgencyIdPathYesId of media agency86b35325-794c-11e4-8425-daf437376f87
clientIdPathYesId of client86b35326-794c-11e4-8425-daf437376f87
campaignIdPathYesId of campaign. Must be "default" in v1default
activityIdPathYesId of activity86b35327-794c-11e4-8425-daf437376f87
apikeyQueryYesAPI key for authentication and authorizationsecretkey123

Response JSON body

ParameterParameter TypeDescriptionExample
top levelArray of BiddingPlanBidding PlansSee below

BiddingPlan Object

ParameterParameter TypeDescriptionExample
bidding_plan_idStringId of bidding plan"86b35328-794c-11e4-8425-daf437376f87"
bidding_planStringName of bidding plan"Example Bidding Plan"
bidding_platformsArray of BiddingPlatformBidding PlatformsSee below

BiddingPlatform Object

ParameterParameter TypeDescriptionExample
nameStringName of bidding platform"Example Bidding Platform"
entryEntryEntrySee below

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87/live_statistics?apikey=secret123

Example Response

[
  {
    "bidding_plan_id": "86b35328-794c-11e4-8425-daf437376f87",
    "bidding_plan": "Example Bidding Plan 1",
    "bidding_platforms": [
      {
        "name": "Example Bidding Platform 1",
        "entry": {
          "bids": 1000,
          "impressions": 1000,
          "clicks": 50,
          "vt_orders": 4,
          "ct_orders": 1,
          "cost": 2.5,
          "range_begin": "2014-01-01T00:00:00.000Z",
          "range_end": "2014-01-01T23:59:59.999Z"
        }
      },
      {
        "name": "Example Bidding Platform 2",
        "entry": {
          "bids": 1000,
          "impressions": 1000,
          "clicks": 50,
          "vt_orders": 4,
          "ct_orders": 1,
          "cost": 2.5,
          "range_begin": "2014-01-01T00:00:00.000Z",
          "range_end": "2014-01-01T23:59:59.999Z"
        }
      }
    ]
  },
  {
    "bidding_plan_id": "86b35329-794c-11e4-8425-daf437376f87",
    "bidding_plan": "Example Bidding Plan 2",
    "bidding_platforms": [
      {
        "name": "Example Bidding Platform 1",
        "entry": {
          "bids": 1000,
          "impressions": 1000,
          "clicks": 50,
          "vt_orders": 4,
          "ct_orders": 1,
          "cost": 2.5,
          "range_begin": "2014-01-01T00:00:00.000Z",
          "range_end": "2014-01-01T23:59:59.999Z"
        }
      },
      {
        "name": "Example Bidding Platform 2",
        "entry": {
          "bids": 1000,
          "impressions": 1000,
          "clicks": 50,
          "vt_orders": 4,
          "ct_orders": 1,
          "cost": 2.5,
          "range_begin": "2014-01-01T00:00:00.000Z",
          "range_end": "2014-01-01T23:59:59.999Z"
        }
      }
    ]
  }
]