Overview

Returns a summary of credit usage and entitlements for the specified API category.

Quickstart

Follow these two steps to make a request and recognize a successful response.

curl --request GET \
  --url https://uapi.demandbase.com/reporting/v1/usage?apiProduct=b2bApi \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"

{
  "summary": {
    "scope": "lifetime",
    "totalCreditsAllocated": 50000,
    "totalCreditsConsumed": 115,
    "totalCreditsAvailable": 49885
  }
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Credit usage details fetched successfully.

The response schema does not enumerate fields; inspect the example response and status code.

Rules

• Use GET with the path /reporting/v1/usage.
• Required inputs: apiProduct.
• Authenticate every request with a valid Demandbase access token.
• This endpoint does not require a JSON request body.

Filters

The published schema exposes the following endpoint inputs. Use the location column to place each value correctly.

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

Next steps

Back to top