Get a Report's Metadata

This endpoint retrieves the report's metadata, which contains the status of the report, so you can know if something went wrong with your report, or if it is ready to retrieve, and so on.

Method GET
URL /v2/reports/{reportId}
Header Authentication header (x-o-api-key)
Content type application/json
URL params Provide the ID of the report in the {reportId} parameter, which you get after successfully submitting a report for creation.
Query params -
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 category and subcategory december 2016",
  "reportDefinition": {
    "startDateTime": "2016-12-01T00:00Z",
    "endDateTime": "2017-01-01T00:00Z",
    "timeGranularity": "none",
    "dimensions": ["category","category"],
    "metrics": ["impression"],
    "filters": []
  },
  "requestSource": "UI",
    "rowCount": 4,
    "maxRows": 100000
}
The reportStatus can have the following values:
  • WAITING
  • IN_PROGRESS
  • QUEUED
  • READY
  • CANCELLED
  • FAILED

The creationDate is a long timestamp.

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/e683514b-b4c9-4988-9b2f-9d6a6a300c08 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": "2018-01-22T14:23:19.247Z",
  "reportName": "Impressions per category and subcategory december 2016",
  "reportDefinition": {
    "startDateTime": "2016-12-01T00:00Z",
    "endDateTime": "2017-01-01T00:00Z",
    "timeGranularity": "none",
    "dimensions": ["category","category"],
    "metrics": ["impression"],
    "filters": []
  },
  "requestSource": "UI",
    "rowCount": 4,
    "maxRows": 100000
 }

해당 내용이 도움 되었습니까?