Get a queued billing report (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

GET /admin/billing/report/{reportId}

Access token

Returns the status of a PDF billing report the caller requested, with a temporary download link once it is ready, the error when it failed and the organizations left out because they could not be rendered. Returns 404 for an unknown report or while billing reports are turned off, and 403 for a report another admin requested. Super admin only.

Path parameters

reportId string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  reportId string Required
  
  status string Required
  
  Values are QUEUED, PROCESSING, COMPLETED, or FAILED.
  
  downloadUrl string | null
  
  error string | null
  
  skippedOrganizations array[string] Required
- statusCode number Required
- timestamp string(date-time) Required

GET /admin/billing/report/{reportId}

curl \
 --request GET 'http://api.example.com/admin/billing/report/{reportId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "reportId": "string",
    "status": "QUEUED",
    "downloadUrl": "string",
    "error": "string",
    "skippedOrganizations": [
      "string"
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}