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": "2017-05-18T09: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"
}
The reportStatus can have the following values:
  • WAITING
  • IN_PROGRESS
  • QUEUED
  • READY
  • CANCELLED
  • ERROR

The creationDate is a long timestamp.

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": "2017-05-18T09: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"
 }

Was this article helpful?