Get campaign report (GET /v1/creator-campaigns/{campaignId}/report)

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the creator_campaigns resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`campaignId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/report" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/report", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/report",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

reportobjectrequired
- spendobjectrequired
  3 child fields
  - budgetCentsintegerrequired
  - consumedCentsintegerrequired
  - settledCentsintegerrequired
- viewsobjectrequired
  2 child fields
  - eligibleintegerrequired
  - totalintegerrequired
- submissionsobjectrequired
  7 child fields
  - receivedintegerrequired
  - trackingintegerrequired
  - pending_reviewintegerrequired
  - approvedintegerrequired
  - rejectedintegerrequired
  - expiredintegerrequired
  - withdrawnintegerrequired
- participantsarray of objectrequired
  5 child fields
  - participantIdstringrequired
  - creatorobjectrequired
    2 child fields
    idstringrequired
    displayNamestringrequired
  - payableCentsintegerrequired
  - settlingCentsintegerrequired
  - settledCentsintegerrequired
- authenticityarray of objectrequired
  3 child fields
  - fromintegerrequired
  - tointegerrequired
  - countintegerrequired

200 response

{
  "report": {
    "spend": {
      "budgetCents": 1,
      "consumedCents": 1,
      "settledCents": 1
    },
    "views": {
      "eligible": 1,
      "total": 42
    },
    "submissions": {
      "received": 1,
      "tracking": 1,
      "pending_review": 1,
      "approved": 1,
      "rejected": 1,
      "expired": 1,
      "withdrawn": 1
    },
    "participants": [
      {
        "participantId": "6f0150243551cb6ee41f35e0",
        "creator": {
          "id": "6bfebd43ddc270f6d2c56fc5",
          "displayName": "Acme"
        },
        "payableCents": 1,
        "settlingCents": 1,
        "settledCents": 1
      }
    ],
    "authenticity": [
      {
        "from": 1,
        "to": 1,
        "count": 42
      }
    ]
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

Request

Path parameters

Example

Response

Errors

More in Creator Campaigns