Batch windowed account metrics

curl --request POST \
  --url https://api.creatoraudit.com/v2/accounts/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "period": "30d",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25"
}
'

import requests

url = "https://api.creatoraudit.com/v2/accounts/metrics"

payload = {
    "account_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "period": "30d",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    period: '30d',
    start_date: '2023-12-25',
    end_date: '2023-12-25'
  })
};

fetch('https://api.creatoraudit.com/v2/accounts/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {},
  "meta": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

Analytics

Batch windowed account metrics

Windowed engagement totals for a batch of entities.

For each requested id, returns the SUM of views, plays, likes, comments, shares, and the derived engagement (likes+comments+shares) over the resolved [start_date, end_date] window. Read-only. Ids your organization does not track are omitted from data and listed under meta.not_found. Response shape:

{ "data": { "<id>": { "views": 1234, "plays": 1200, "likes": 56,
                       "comments": 7, "shares": 8, "engagement": 71 } },
  "meta": { "period": "30d", "start_date": "...", "end_date": "...",
            "days": 30, "not_found": ["<unknown_id>"] } }

Note: TikTok has no separate plays count, so a TikTok entity’s plays equals its views. There is no impressions metric — the platform tracks views and plays only.

POST

accounts

metrics

Batch windowed account metrics

curl --request POST \
  --url https://api.creatoraudit.com/v2/accounts/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "period": "30d",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25"
}
'

import requests

url = "https://api.creatoraudit.com/v2/accounts/metrics"

payload = {
    "account_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "period": "30d",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    period: '30d',
    start_date: '2023-12-25',
    end_date: '2023-12-25'
  })
};

fetch('https://api.creatoraudit.com/v2/accounts/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {},
  "meta": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "instance": "<string>",
  "errors": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

account_ids

string<uuid>[]

required

Org account UUIDs to window (1–200).

Required array length: 1 - 200 elements

period

enum<string>

default:30d

Preset window (7d/30d/90d) or 'custom' with start_date/end_date.

Available options:

7d,

30d,

90d,

custom

start_date

string<date> | null

Inclusive UTC start; required when period=custom.

end_date

string<date> | null

Inclusive UTC end; required when period=custom.

Response

Successful Response

data

object

required

Show child attributes

Conventions

Accounts

Videos

Creators

Analytics

Overview

Search

System

Batch windowed account metrics

Authorizations

Body

Response