HubSpot: Retrieve API Usage

← Account info operations · Get started

Operation hubspot.account_info_get_usage_details

Provider route: GET /account-info/2026-09/api-usage/daily/private-apps. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["accountInfo"]["getUsageDetails"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.accountInfo.getUsageDetails(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.account_info.get_usage_details(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Retrieve API Usage — response body

Referenced models: Retrieve API Usage — response body

Schemas

Retrieve API Usage — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of API usage records, each detailing the usage metrics for a specific API. Each record includes information such as the name of the API, usage limits, current usage, and the status of the data fetch.
results[]	Model	Each item	Expand Retrieve API Usage — response body — results item

Referenced models: Retrieve API Usage — response body — results item

Retrieve API Usage — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
collectedAt	string	Required within parent	The date and time when the usage data was collected, in ISO 8601 format. Format: date-time
currentUsage	JSON	Required within parent
currentUsage (anyOf 1)	integer	Alternative	An integer indicating the current usage count of the API resource. Format: int32
currentUsage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fetchStatus	string	Required within parent	The status of the data fetch operation. Valid values include 'SUCCESS', 'TIMEOUT', 'FAILURE', 'CACHED', and 'NOTFOUND'. Known values: CACHED, FAILURE, NOTFOUND, SUCCESS, TIMEOUT
name	string	Required within parent	The name of the API resource being tracked.
resetsAt	string	Optional	The date and time when the usage limit will reset, in ISO 8601 format. Format: date-time
usageLimit	JSON	Required within parent
usageLimit (anyOf 1)	integer	Alternative	An integer representing the maximum allowable usage for the API resource. Format: int32
usageLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.account_info_get_usage_details. Catalog operation: account_info_get_usage_details. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["oauth"]

Official provider source