Get All Report Definitions

This endpoint allows you to retrieve a list of all your reports, which includes their IDs, names and statuses.

Method GET
URL /v2/reports
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
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": "report name",
    "reportDefinition": null
  },
  {
    "reportId": "e71f37d6-c757-410d-a1ad-81d2d9af33b0",
    "reportStatus": "READY",
    "creationDate": "2017-03-20T13:46:25.037Z",
    "reportName": "other report name",
    "reportDefinition": null
  }
]
Error response  

Example

Request header:

GET /v2/reports 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": "report name",
      "reportDefinition": null
    },
    {
      "reportId": "e71f37d6-c757-410d-a1ad-81d2d9af33b0",
      "reportStatus": "READY",
      "creationDate": "2017-03-20T13:46:25.037Z",
      "reportName": "other report name",
      "reportDefinition": null
    }
  ]

Was this article helpful?