Edit

GET Account Summary

Returns performance metrics for an account's total activity for a given time period, time zone and currency.

Description

Call this API endpoint to receive account level performance metrics for a specified time period, timezone and currency.

Request

Path

GET /reporting/accounts/{accountId}/summary

Parameters

Name	Type	In	Description	Required	Example
dateStart	String	query	Start time of the requested date/time range	true	dateStart=2020-03-01T00:00:00.000
dateEnd	String	query	End time of the requested date/time range	true	dateEnd=2020-03-31T23:59:59.000
currency	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Currency code in which you will receive monetary metrics.	true	currency=USD
timeZoneVariation	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Desired timezone can be passed through this parameter. It has to be in Olson format.	true	timeZoneVariation=Australia/Sydney
accountId	String	path		true

Response

200 OK

Example Value

Schema

{
  "campaignsSummary": {
    "grossCost": 0,
    "netCost": 0,
    "impressions": 0,
    "uniqueSessions": 0,
    "referrals": 0,
    "acquisitionsByConversionDate": 0,
    "acquisitionsByReferralDate": 0,
    "campaigns": 0,
    "creatives": 0,
    "audiences": 0,
    "campaignCountries": 0
  },
  "transactionsSummary": {
    "revenue": 0,
    "transactions": 0,
    "placementImpressions": 0,
    "impressions": 0,
    "referrals": 0,
    "rpt": 0,
    "rpm": 0,
    "positivePlacementEngagements": 0,
    "purchases": 0
  }
}

Object {

campaignsSummary: AllOf Object {

grossCost: Number

netCost: Number

impressions: Number

uniqueSessions: Number

referrals: Number

acquisitionsByConversionDate: Number

acquisitionsByReferralDate: Number

campaigns: Number

creatives: Number

audiences: Number

campaignCountries: Number

}

transactionsSummary: AllOf Object {

revenue: Number

transactions: Number

placementImpressions: Number

impressions: Number

referrals: Number

rpt: Number

rpm: Number

positivePlacementEngagements: Number

purchases: Number

}

}