VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Ad_accounts
Analytics
Api_keys
Session
Component_dev_sessions
Component_registry
Components
Sandbox
Events
Experiments
Feature_flags
Ingest_policy
Push_notifications
Organizations
Payment_providers
Payment_provider_products
Payment_sources
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Me
Webhooks
Audit_log
Organization_members
Notices
Connected_apps
Tracking_domains
Ads
Payment_provider_history_imports
Feedback
Analytics
Event capture
List Campaigns
Get Campaign
List Ad Groups
Get Ad Group
List Ads
Get Ad
Get Settings
Update Settings
Report Performance
Report Creatives
Report Cohorts
Report Changes

Report Creatives

POST
/api/v1/projects/{projectId}/ads/reports/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
formats?array<>|null
search?|null
limit?|null
cursor?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/projects/string/ads/reports/creatives" \  -H "Content-Type: application/json" \  -d '{    "from": "string",    "to": "string"  }'
{  "data": [    {      "id": "string",      "name": "string",      "format": "image",      "videoDurationSeconds": -9007199254740991,      "cardCount": -9007199254740991,      "thumbnailUrl": "string",      "adCount": -9007199254740991,      "deliveryStatus": "delivering",      "adsInDeliveryStatus": -9007199254740991,      "spend": -9007199254740991,      "ctr": 0,      "hookRate": 0,      "platformRoas": 0,      "roas": 0,      "costPerPayer": -9007199254740991,      "fatigue": {        "frequency": 0,        "ctrChange": 0,        "days": -9007199254740991      },      "platformUrl": "string"    }  ],  "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"      ]    }  ]}
{  "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"  }}
PreviousReport PerformanceNextReport Cohorts