> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PitchBook: Get Endpoint Usage Report

> Usage Report. PitchBook Get Endpoint Usage Report reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Usage Report.

<Info>
  Tool ID: `pitchbook_get_endpoint_usage_report`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
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

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

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

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

Use `deepline tools get 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 |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves information concerning calls made during the specific timeframe (for up to the last 30 days).",
    "properties": {
      "sinceDate": {
        "type": "string",
        "description": "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"
      },
      "trailingRange": {
        "type": "integer",
        "description": "Add this parameter to extract information for the last N days"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "stats": {
            "type": "object",
            "properties": {
              "endpoints": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "totalCountOfCalls": {
                "type": "integer",
                "format": "int32"
              },
              "totalChargedCredits": {
                "type": "integer",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "rawData": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "contractNumber": {
                  "type": "string"
                },
                "request": {
                  "type": "string"
                },
                "requestDate": {
                  "type": "string",
                  "format": "date-time"
                },
                "responseStatus": {
                  "type": "string"
                },
                "endpointType": {
                  "type": "string"
                },
                "chargedCredits": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [PitchBook provider guide](/docs/providers/pitchbook/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.