Get Metadata for All Reports

This endpoint allows you to retrieve a list of all your reports, which includes their ID, name, status, and so on.

Method GET
URL /v2/reports
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params
  • limit: (optional) set the amount of last created reports from which you want to retrieve the metadata. For example, setting limit to 10, retrieves the metadata for the last 10 created reports.
  • requestSource: (optional) filter reports on where they were created. The values can be:
    • UI: to indicate that the report was created through the user interface
    • API: to indicate that the report was created through the REST API

    Filtering reports happens before applying the set limit.

Body -
Success response

HTTP status: 200 OK

Header: -

Body:

[
  {
    "reportId": "e683514b-b4c9-4988-9b2f-9d6a6a300c08",
    "reportStatus": "READY",
    "creationDate": "2018-01-22T14:23:19.247Z",
    "reportName": "Impressions per month Second Quarter 2017",
    "reportDefinition": {
      "startDateTime": "2018-01-16T00:00Z[Europe/Stockholm]",
      "endDateTime" : "2018-01-22T00:00Z[Europe/Stockholm]",
      "timeGranularity": "month",
      "dimensions": [],
      "metrics": ["impression"],
      "filters": []
    },
    "requestSource": "UI",
    "rowCount": 55,
    "maxRows": 100000
  },
  {
    "reportId": "e71f37d6-c757-410d-a1ad-81d2d9af33b0",
    "reportStatus": "READY",
    "creationDate": "2018-01-22T14:23:19.247Z",
    "reportName": "Impressions and CTR 2016 for Mobile per Subcategory",
    "reportDefinition": {
      "startDateTime": "2016-01-01T00:00Z[Europe/Stockholm]",
      "endDateTime" : "2017-01-01T00:00Z[Europe/Stockholm]",
      "timeGranularity": "none",
      "dimensions": ["cateogory","category"],
      "metrics": ["impression","ctr"],
      "filters": [
        {
          "type": "in",
          "dimension": "device_container",
          "values": ["50ae027e-162d-4acd-a905-64c12a68d37b"]
        }
      ]
    },
    "requestSource": "API",
    "rowCount": 75,
    "maxRows": 100000
  }
]

For reports created from 22 January 2018, the fields rowCount and maxRows allow you to see how close you are to reaching the limit of 100000 rows per report. If the data you are querying for exceeds the 100000 rows limit, your report will be incomplete.

To make sure you get a complete report, you should query for less data. Try the following tips:
  • Split reports based on time period. For example, query for each quarter separately instead of querying for an entire year.
  • Remove one or more campaigns or goals from your selected filters, or create a report per campaign.
  • Narrow down the data by selecting more filters.
  • Remove one or more of the selected dimensions. If you have selected one or more dimensions with a high cardinality, query them separately.
  • For the Time dimension, select a less granular breakdown of data. For example, select month instead of day.

Example

Request header:

GET /v2/reports?limit=2 HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/json
x-o-api-key="<your key>"

Request body: -

Success response:

HTTP status:
  200 (OK)

Header: -

Body:
 [
  {
    "reportId": "e683514b-b4c9-4988-9b2f-9d6a6a300c08",
    "reportStatus": "READY",
    "creationDate": "2017-05-18T09:23:19.247Z",
    "reportName": "Impressions per month Second Quarter 2017",
    "reportDefinition": {
      "startDateTime": "2017-04-01T00:00Z[Europe/Stockholm]",
      "endDateTime" : "2017-07-01T00:00Z[Europe/Stockholm]",
      "timeGranularity": "month",
      "dimensions": [],
      "metrics": ["impression"],
      "filters": []
    },
    "requestSource": "UI",
    "rowCount": 55,
    "maxRows": 100000
  },
  {
    "reportId": "e71f37d6-c757-410d-a1ad-81d2d9af33b0",
    "reportStatus": "READY",
    "creationDate": "2017-03-20T13:46:25.037Z",
    "reportName": "Impressions and CTR 2016 for Mobile per Subcategory",
    "reportDefinition": {
      "startDateTime": "2016-01-01T00:00Z[Europe/Stockholm]",
      "endDateTime" : "2017-01-01T00:00Z[Europe/Stockholm]",
      "timeGranularity": "none",
      "dimensions": ["cateogory","category"],
      "metrics": ["impression","ctr"],
      "filters": [
        {
          "type": "in",
          "dimension": "device_container",
          "values": ["50ae027e-162d-4acd-a905-64c12a68d37b"]
        }
      ]
    },
    "requestSource": "API",
    "rowCount": 75,
    "maxRows": 100000
  }
 ]
https://help.ooyala.com/sites/all/libraries/dita/en/video-advertising/oadtech/ad_serving/dg/rest_custom_reporting_get_all_reports.html

Was this article helpful?