PitchBook: Get Endpoint Usage Report

Report the API calls your PitchBook account made over a time window of up to the last 30 days.

Tool ID: pitchbook_get_endpoint_usage_report

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_get_endpoint_usage_report',
  {
    "sinceDate": "2026-01-15T12:00:00Z",
    "trailingRange": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pitchbook_get_endpoint_usage_report --input '{
  "sinceDate": "2026-01-15T12:00:00Z",
  "trailingRange": 123
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "stats": {
      "endpoints": [
        "example"
      ],
      "totalCountOfCalls": 123,
      "totalChargedCredits": 123
    },
    "rawData": [
      {
        "contractNumber": "example",
        "request": "example",
        "requestDate": "2026-01-15T12:00:00Z"
      }
    ]
  }
}

Use deepline describe pitchbook_get_endpoint_usage_report --json for the latest machine-readable contract.

Input reference

Retrieves information concerning calls made during the specific timeframe (for up to the last 30 days).

Name	Type	Required	Default	Details
`payload.sinceDate`	`string`	No	—	Add this parameter to extract information for a certain date with the > operator, before a certain date with the < operator and between 2 dates with the ^ operator Format: YYYY-MM-DD
`payload.trailingRange`	`integer`	No	—	Add this parameter to extract information for the last N days

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.stats`	`object`	No	—	—
`result.data.stats.endpoints`	`array`	No	—	—
`result.data.stats.totalCountOfCalls`	`integer`	No	—	Format: `int32`.
`result.data.stats.totalChargedCredits`	`integer`	No	—	Format: `int32`.
`result.data.rawData`	`array`	No	—	—
`result.data.rawData[].contractNumber`	`string`	No	—	—
`result.data.rawData[].request`	`string`	No	—	—
`result.data.rawData[].requestDate`	`string`	No	—	Format: `date-time`.
`result.data.rawData[].responseStatus`	`string`	No	—	—
`result.data.rawData[].endpointType`	`string`	No	—	—
`result.data.rawData[].chargedCredits`	`integer`	No	—	Format: `int32`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation