Get Usage by Initiator

curl --request GET \
  --url https://api.politicalcomms.com/v1/ledger/usage/by-initiator \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "data": {
    "period": {
      "start_date": "2026-01-01",
      "end_date": "2026-01-31"
    },
    "by_initiator": [
      {
        "initiator_org_id": "org_child_1",
        "initiator_org_name": "Regional Office East",
        "messages_sent": 580000,
        "total_charges": 5800
      },
      {
        "initiator_org_id": "org_child_2",
        "initiator_org_name": "Regional Office West",
        "messages_sent": 872300,
        "total_charges": 8723
      }
    ]
  }
}

GET

ledger

usage

by-initiator

Get Usage by Initiator

curl --request GET \
  --url https://api.politicalcomms.com/v1/ledger/usage/by-initiator \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "data": {
    "period": {
      "start_date": "2026-01-01",
      "end_date": "2026-01-31"
    },
    "by_initiator": [
      {
        "initiator_org_id": "org_child_1",
        "initiator_org_name": "Regional Office East",
        "messages_sent": 580000,
        "total_charges": 5800
      },
      {
        "initiator_org_id": "org_child_2",
        "initiator_org_name": "Regional Office West",
        "messages_sent": 872300,
        "total_charges": 8723
      }
    ]
  }
}

Authorizations

X-API-Key

string

header

required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Query Parameters

startDate

string<date>

required

Start date in YYYY-MM-DD format

Example:

"2026-01-01"

endDate

string<date>

required

End date in YYYY-MM-DD format

Example:

"2026-01-31"

organizationId

string

Filter to a specific descendant organization

Response

Successful response

Get Usage