/billing/usage

GET

/billing/usage

const url = 'https://api.chatfood.app/billing/usage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.chatfood.app/billing/usage \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer
ApiKey

Parameters

Query Parameters

accountId

string format: uuid

from

string format: date

pageIds

Array<string>

Responses

200

object

accountId

string format: uuid

from

string format: date

totals

object

pages

integer format: int64

presenceDays

integer format: int64

activeLeads

number format: double

activeLeadsPeak

number format: double

activeLeadsDays

integer format: int64

totalLeads

number format: double

blockedLeads

number format: double

deletedLeads

number format: double

unsubscribedLeads

number format: double

newLeads

number format: double

broadcastExecutions

number format: double

broadcastLeadsSent

number format: double

uniqueLeadsReachedMonth

number format: double

uniqueLeadsReachedMeasuredPages

integer format: int64

pages

Array<object>

nullable

object

groupId

string format: uuid

groupKind

string

nullable

groupName

string

nullable

companyId

string format: uuid

nullable

companyName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

metrics

object

pages

integer format: int64

presenceDays

integer format: int64

activeLeads

number format: double

activeLeadsPeak

number format: double

activeLeadsDays

integer format: int64

totalLeads

number format: double

blockedLeads

number format: double

deletedLeads

number format: double

unsubscribedLeads

number format: double

newLeads

number format: double

broadcastExecutions

number format: double

broadcastLeadsSent

number format: double

uniqueLeadsReachedMonth

number format: double

uniqueLeadsReachedMeasuredPages

integer format: int64

days

Array<object>

nullable

object

pageId

string format: uuid

day

string format: date

type

string

nullable

value

number format: double

catalogue

Array<object>

nullable

object

type

integer format: int32

key

string

nullable

aggregation

string

nullable

confidence

string

nullable

object

accountId

string format: uuid

from

string format: date

totals

object

pages

integer format: int64

presenceDays

integer format: int64

activeLeads

number format: double

activeLeadsPeak

number format: double

activeLeadsDays

integer format: int64

totalLeads

number format: double

blockedLeads

number format: double

deletedLeads

number format: double

unsubscribedLeads

number format: double

newLeads

number format: double

broadcastExecutions

number format: double

broadcastLeadsSent

number format: double

uniqueLeadsReachedMonth

number format: double

uniqueLeadsReachedMeasuredPages

integer format: int64

pages

Array<object>

nullable

object

groupId

string format: uuid

groupKind

string

nullable

groupName

string

nullable

companyId

string format: uuid

nullable

companyName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

metrics

object

pages

integer format: int64

presenceDays

integer format: int64

activeLeads

number format: double

activeLeadsPeak

number format: double

activeLeadsDays

integer format: int64

totalLeads

number format: double

blockedLeads

number format: double

deletedLeads

number format: double

unsubscribedLeads

number format: double

newLeads

number format: double

broadcastExecutions

number format: double

broadcastLeadsSent

number format: double

uniqueLeadsReachedMonth

number format: double

uniqueLeadsReachedMeasuredPages

integer format: int64

days

Array<object>

nullable

object

pageId

string format: uuid

day

string format: date

type

string

nullable

value

number format: double

catalogue

Array<object>

nullable

object

type

integer format: int32

key

string

nullable

aggregation

string

nullable

confidence

string

nullable

Example^generated

{
  "accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "from": "2026-04-15",
  "to": "2026-04-15",
  "totals": {
    "pages": 1,
    "presenceDays": 1,
    "activeLeads": 1,
    "activeLeadsPeak": 1,
    "activeLeadsDays": 1,
    "totalLeads": 1,
    "blockedLeads": 1,
    "deletedLeads": 1,
    "unsubscribedLeads": 1,
    "newLeads": 1,
    "broadcastExecutions": 1,
    "broadcastLeadsSent": 1,
    "uniqueLeadsReachedMonth": 1,
    "uniqueLeadsReachedMeasuredPages": 1
  },
  "pages": [
    {
      "groupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "groupKind": "example",
      "groupName": "example",
      "companyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "companyName": "example",
      "accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "accountName": "example",
      "metrics": {
        "pages": 1,
        "presenceDays": 1,
        "activeLeads": 1,
        "activeLeadsPeak": 1,
        "activeLeadsDays": 1,
        "totalLeads": 1,
        "blockedLeads": 1,
        "deletedLeads": 1,
        "unsubscribedLeads": 1,
        "newLeads": 1,
        "broadcastExecutions": 1,
        "broadcastLeadsSent": 1,
        "uniqueLeadsReachedMonth": 1,
        "uniqueLeadsReachedMeasuredPages": 1
      }
    }
  ],
  "days": [
    {
      "pageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "day": "2026-04-15",
      "type": "example",
      "value": 1
    }
  ],
  "catalogue": [
    {
      "type": 1,
      "key": "example",
      "aggregation": "example",
      "confidence": "example"
    }
  ]
}

object

accountId

string format: uuid

from

string format: date

totals

object

pages

integer format: int64

presenceDays

integer format: int64

activeLeads

number format: double

activeLeadsPeak

number format: double

activeLeadsDays

integer format: int64

totalLeads

number format: double

blockedLeads

number format: double

deletedLeads

number format: double

unsubscribedLeads

number format: double

newLeads

number format: double

broadcastExecutions

number format: double

broadcastLeadsSent

number format: double

uniqueLeadsReachedMonth

number format: double

uniqueLeadsReachedMeasuredPages

integer format: int64

pages

Array<object>

nullable

object

groupId

string format: uuid

groupKind

string

nullable

groupName

string

nullable

companyId

string format: uuid

nullable

companyName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

metrics

object

pages

integer format: int64

presenceDays

integer format: int64

activeLeads

number format: double

activeLeadsPeak

number format: double

activeLeadsDays

integer format: int64

totalLeads

number format: double

blockedLeads

number format: double

deletedLeads

number format: double

unsubscribedLeads

number format: double

newLeads

number format: double

broadcastExecutions

number format: double

broadcastLeadsSent

number format: double

uniqueLeadsReachedMonth

number format: double

uniqueLeadsReachedMeasuredPages

integer format: int64

days

Array<object>

nullable

object

pageId

string format: uuid

day

string format: date

type

string

nullable

value

number format: double

catalogue

Array<object>

nullable

object

type

integer format: int32

key

string

nullable

aggregation

string

nullable

confidence

string

nullable

Example^generated

{
  "accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "from": "2026-04-15",
  "to": "2026-04-15",
  "totals": {
    "pages": 1,
    "presenceDays": 1,
    "activeLeads": 1,
    "activeLeadsPeak": 1,
    "activeLeadsDays": 1,
    "totalLeads": 1,
    "blockedLeads": 1,
    "deletedLeads": 1,
    "unsubscribedLeads": 1,
    "newLeads": 1,
    "broadcastExecutions": 1,
    "broadcastLeadsSent": 1,
    "uniqueLeadsReachedMonth": 1,
    "uniqueLeadsReachedMeasuredPages": 1
  },
  "pages": [
    {
      "groupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "groupKind": "example",
      "groupName": "example",
      "companyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "companyName": "example",
      "accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "accountName": "example",
      "metrics": {
        "pages": 1,
        "presenceDays": 1,
        "activeLeads": 1,
        "activeLeadsPeak": 1,
        "activeLeadsDays": 1,
        "totalLeads": 1,
        "blockedLeads": 1,
        "deletedLeads": 1,
        "unsubscribedLeads": 1,
        "newLeads": 1,
        "broadcastExecutions": 1,
        "broadcastLeadsSent": 1,
        "uniqueLeadsReachedMonth": 1,
        "uniqueLeadsReachedMeasuredPages": 1
      }
    }
  ],
  "days": [
    {
      "pageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "day": "2026-04-15",
      "type": "example",
      "value": 1
    }
  ],
  "catalogue": [
    {
      "type": 1,
      "key": "example",
      "aggregation": "example",
      "confidence": "example"
    }
  ]
}

/billing/usage

Authorizations

Parameters

Query Parameters

Responses

200

Examplegenerated

Examplegenerated

Example^generated

Example^generated