Report Performance

PreviousUpdate Settings NextReport Creatives

Path Parameters

projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

from*string

to*string

currency?string|null

timezone?|null

environment?|null

level*AdsReportLevel

Value in

"campaign"
"ad_group"
"ad"

breakdown?|null

campaignIds?array<string>|null

adGroupIds?array<string>|null

delivery?|null

destination?|null

search?|null

include?array<>|null

sort?|null

limit?|null

cursor?string|null

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/projects/string/ads/reports/performance" \  -H "Content-Type: application/json" \  -d '{    "from": "string",    "to": "string",    "level": "campaign"  }'

{  "data": [    {      "id": "string",      "name": "string",      "campaignId": "string",      "adGroupId": "string",      "deliveryStatus": "delivering",      "destination": "website",      "platformUrl": "string",      "reported": {        "spend": -9007199254740991,        "impressions": -9007199254740991,        "reach": -9007199254740991,        "frequency": 0,        "linkClicks": -9007199254740991,        "ctr": 0,        "purchaseValue": -9007199254740991,        "platformRoas": 0,        "results": [          {            "type": "landing_page_view",            "label": "string",            "count": -9007199254740991          }        ]      },      "measured": {        "visits": -9007199254740991,        "installs": -9007199254740991,        "signups": -9007199254740991,        "trials": -9007199254740991,        "payers": -9007199254740991,        "keyConversions": -9007199254740991,        "grossRevenue": -9007199254740991,        "refunds": -9007199254740991,        "netRevenue": -9007199254740991,        "roas": 0,        "costPerSignup": -9007199254740991,        "costPerPayer": -9007199254740991,        "costPerKeyConversion": -9007199254740991      },      "breakdown": [        {          "value": "string",          "reported": {            "spend": -9007199254740991,            "impressions": -9007199254740991,            "reach": -9007199254740991,            "frequency": 0,            "linkClicks": -9007199254740991,            "ctr": 0,            "purchaseValue": -9007199254740991,            "platformRoas": 0,            "results": [              {                "type": "landing_page_view",                "label": "string",                "count": -9007199254740991              }            ]          },          "measured": {            "visits": -9007199254740991,            "installs": -9007199254740991,            "signups": -9007199254740991,            "trials": -9007199254740991,            "payers": -9007199254740991,            "keyConversions": -9007199254740991,            "grossRevenue": -9007199254740991,            "refunds": -9007199254740991,            "netRevenue": -9007199254740991,            "roas": 0,            "costPerSignup": -9007199254740991,            "costPerPayer": -9007199254740991,            "costPerKeyConversion": -9007199254740991          }        }      ]    }  ],  "pageInfo": {    "endCursor": "string",    "hasNextPage": true  },  "from": "string",  "to": "string",  "currency": "string",  "timezone": "string",  "environment": "production",  "hasMeasuredAccess": true,  "provisionalFrom": "string",  "warnings": [    {      "code": "currency_converted",      "currencies": [        "string"      ]    }  ],  "level": "campaign",  "breakdown": "placement",  "keyConversion": "link_click",  "totals": {    "reported": {      "spend": -9007199254740991,      "impressions": -9007199254740991,      "reach": -9007199254740991,      "frequency": 0,      "linkClicks": -9007199254740991,      "ctr": 0,      "purchaseValue": -9007199254740991,      "platformRoas": 0,      "results": [        {          "type": "landing_page_view",          "label": "string",          "count": -9007199254740991        }      ]    },    "measured": {      "visits": -9007199254740991,      "installs": -9007199254740991,      "signups": -9007199254740991,      "trials": -9007199254740991,      "payers": -9007199254740991,      "keyConversions": -9007199254740991,      "grossRevenue": -9007199254740991,      "refunds": -9007199254740991,      "netRevenue": -9007199254740991,      "roas": 0,      "costPerSignup": -9007199254740991,      "costPerPayer": -9007199254740991,      "costPerKeyConversion": -9007199254740991    }  },  "unallocated": {    "spend": -9007199254740991,    "impressions": -9007199254740991,    "clicks": -9007199254740991,    "linkClicks": -9007199254740991  }}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "unauthenticated",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "permission_denied",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "not_found",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "internal",    "code": "string",    "message": "string",    "param": "string"  }}

Report Performance

Report Performance

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`