Reports

The reports endpoints allows you to retrieve reportIds. These IDs can be passed to the data endpoint to pull any desired metrics from any dimension.

Reports can be filtered by any combination of:

• Advertiser, media partner, or agency.
• Campaign or report status.
• Other tags, such as the report's name, start/end date, and much more.

Request Parameters

• page
  int32
  Defaults to 1
  Reports page index, default = 1

• perPage
  int32
  Defaults to 100
  Max number of reports per page, default = 100

• filters
  array of objects
  Filters to apply to your query.

Response Structure

• page
  integer
  Defaults to 0

• perPage
  integer
  Defaults to 0

• totalPages
  integer
  Defaults to 0

• reports
  array of objects
  Reports data:

{
  "id": "string",
  "name": "string",
  "type": "string",
  "status": "string",
  "startDate": "string",
  "endDate": "string",
  "lastUpdateDate": "string",
  "campaign": {
    "name": "string"
  },
  "advertiser": {
    "name": "string"
  },
  "partner": {
    "name": "string"
  }
}

Example Code Snippet

curl --request POST \
     --url https://mapi.placed.com/reports \
     --header 'accept: application/json' \
     --header 'authorization: Basic ••••' \
     --header 'content-type: application/json' \
     --data '
{
  "page": 1,
  "perPage": 100
}
'

Sample Response

{
  "page": 1,
  "perPage": 5,
  "totalPages": 23,
  "reports": [
    {
      "id": "demo-id-1",
      "name": "Display and Social",
      "type": "OVERLAP",
      "status": "COMPLETED",
      "startDate": "2022-04-14",
      "endDate": "2022-05-15",
      "lastUpdateDate": "2022-06-03",
      "campaign": {
        "name": "Demo"
      },
      "advertiser": {
        "name": "Demo"
      },
      "partner": {
        "name": "Demo"
      }
    },
    {
      "id": "demo-id-2",
      "name": "Display and Linear TV",
      "type": "OVERLAP",
      "status": "COMPLETED",
      "startDate": "2022-04-14",
      "endDate": "2022-05-15",
      "lastUpdateDate": "2022-06-03",
      "campaign": {
        "name": "Demo 2"
      },
      "advertiser": {
        "name": "Demo"
      },
      "partner": {
        "name": "Demo"
      }
    },
    {
      "id": "demo-id-3",
      "name": "Demo 1 and Demo 5",
      "type": "OVERLAP",
      "status": "COMPLETED",
      "startDate": "2021-10-01",
      "endDate": "2021-12-31",
      "lastUpdateDate": "2022-02-12",
      "campaign": {
        "name": "Demo Campaign"
      },
      "advertiser": {
        "name": "Demo"
      },
      "partner": {
        "name": "Demo"
      }
    },
    {
      "id": "demo-id-4",
      "name": "Demo 1 and Demo 4",
      "type": "OVERLAP",
      "status": "COMPLETED",
      "startDate": "2021-10-01",
      "endDate": "2021-12-31",
      "lastUpdateDate": "2022-02-12",
      "campaign": {
        "name": "Demo Campaign"
      },
      "advertiser": {
        "name": "Demo"
      },
      "partner": {
        "name": "Demo"
      }
    },
    {
      "id": "demo-id-5",
      "name": "Demo 1 and Demo 3",
      "type": "OVERLAP",
      "status": "COMPLETED",
      "startDate": "2021-10-01",
      "endDate": "2021-12-31",
      "lastUpdateDate": "2022-02-12",
      "campaign": {
        "name": "Demo Campaign"
      },
      "advertiser": {
        "name": "Demo"
      },
      "partner": {
        "name": "Demo"
      }
    }
  ]
}