API Access

1. API overview

  • The Reporting API uses HTTP API, which tries to follow a RESTful design pattern.
  • The results you get back will be in the JSON format.
  • All numbers are reported in timezone UTC (+00:00).
  • The rate limit of reporting API is 5 requests per second.

2. Account Wide Reporting API

You can query for the data of your account in PubNative platform.

2-1. Endpoint

curl https://dashboard.pubnative.net/api/reports/dsp?account_auth_token={ACCOUNT_AUTH_TOKEN}&start_date={START_DATE}&end_date={END_DATE}

👍

Example

curl https://dashboard.pubnative.net/api/reports/dsp?account_auth_token=123457Ahgbvx&start_date=18/06/2023&end_date=19/06/2023&group_by[]=dsp_name

2-2. Request Parameters

ParameterRequired?DescriptionExample
account_auth_tokenRequiredReporting API access token (unique per account).

Available in dashboard account menu (click Reporting API Key)
1001a00a1234ab1111ab12a1abc
12312311a10000a1a123412345678abc1234
start_dateRequiredStart date of the data (dd/mm/yyyy)25/01/2021
end_dateRequiredEnd date of the data (dd/mm/yyyy)30/01/2021
group_by[]OptionalBy DSP IDdsp_id
group_by[]OptionalBy DSP Namedsp_name

2-3. Example Response

Without Group By

{
  "status": "success",
  "reports": [
    {
      "revenue": 573.12,
      "impressions": 200100,
      "date": "25/01/2021"
    },
    {
      "revenue": 987.88,
      "impressions": 198000,
      "date": "26/01/2021"
    },
    {
      "revenue": 888.56,
      "impressions": 123000,
      "date": "27/01/2021"
    },
    {
      "revenue": 602.81,
      "impressions": 175991,
      "date": "28/01/2021"
    },
    {
      "revenue": 998.33,
      "impressions": 211271,
      "date": "29/01/2021"
    },
    {
      "revenue": 741.59,
      "impressions": 159872,
      "date": "30/01/2021"
    }
  ]
}

Group by DSP ID/Name

{
  "status": "success",
  "reports": [
    {
      "revenue": 8382.86,
      "dsp_id": "31",
      "dsp_name": "ABC",
      "impressions": 22646109,
      "date": "25/03/2023"
    },
    {
      "revenue": 5391.29,
      "dsp_id": "420",
      "dsp_name": "ABC DR",
      "impressions": 21300138,
      "date": "25/03/2023"
    },
    {
      "revenue": 9620.79,
      "dsp_id": "1152",
      "dsp_name": "ABC Display",
      "impressions": 25387136,
      "date": "25/03/2023"
    },
    {
      "revenue": 5.96,
      "dsp_id": "923",
      "dsp_name": "ABC JP Tier A",
      "impressions": 18285,
      "date": "25/03/2023"
    },
    {
      "revenue": 12.23,
      "dsp_id": "948",
      "dsp_name": "ABC JP Tier C",
      "impressions": 39080,
      "date": "25/03/2023"
    }
  ]
}