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": "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": []
    }
  },
  {
    "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"]
        }
      ]
    }
  }
]

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": "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": []
    }
  },
  {
    "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"]
        }
      ]
    }
  }
 ]

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