Skip to main content
POST
/
api_keys
/
usage
/
breakdown
Get API usage breakdown by key and endpoint
curl --request POST \
  --url https://api.pubrio.com/api_keys/usage/breakdown \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "start_date": "2026-05-01",
  "end_date": "2026-05-14",
  "profile_id": 123,
  "keys": [
    "<string>"
  ],
  "log_type_slugs": [
    "<string>"
  ]
}
'
{
  "metadata": {
    "filters": {
      "start_date": "2026-04-01",
      "end_date": "2026-05-14"
    }
  },
  "data": {
    "by_key": [
      {
        "name": "2••••••••••••••••a37",
        "requests": 929,
        "credits": 42766,
        "last_used": "2026-05-05 11:09:42.508",
        "percent_of_requests": 17.892,
        "percent_of_credits": 99.425
      },
      {
        "name": "0••••••••••••••••f39",
        "requests": 175,
        "credits": 187,
        "last_used": "2026-05-14 12:04:21.651",
        "percent_of_requests": 3.37,
        "percent_of_credits": 0.434
      }
    ],
    "by_endpoint": [
      {
        "slug": "people_redeem",
        "name": "Redeem People",
        "requests": 4088,
        "credits": 41215,
        "cost_per_call": 10.08,
        "percent_of_requests": 78.73,
        "percent_of_credits": 95.82
      },
      {
        "slug": "people_search",
        "name": "People Search",
        "requests": 368,
        "credits": 1101,
        "cost_per_call": 2.99,
        "percent_of_requests": 7.08,
        "percent_of_credits": 2.55
      }
    ],
    "totals": {
      "credits": 43013,
      "requests": 5192
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pubrio.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
pubrio-api-key
string
header
required

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
​
start_date
string
required

Start of the date range in YYYY-MM-DD format (interpreted in the workspace timezone).

Example:

"2026-05-01"

​
end_date
string
required

End of the date range in YYYY-MM-DD format (interpreted in the workspace timezone).

Example:

"2026-05-14"

​
profile_id
integer

Optional. An identifier for the user profile (workspace) making the request. This is no longer required as the API key already includes your workspace information. If provided, it helps in associating the lookup with a specific user, allowing for data retrieval and credit tracking.

Check out user details endpoints under the Profile tab for more information.

​
keys
string[]

Optional list of masked API key identifiers (e.g. 0••••••••••••••••f39) to restrict the results to specific keys. Use the masked values returned by /api_keys or by the masked_authentication field on a log entry.

​
log_type_slugs
string[]

Optional list of log type slugs (e.g. people_search, company_search, people_redeem) to restrict the results to specific endpoints.

Response

Successful response containing the API usage breakdown.

​
metadata
object
​
data
object