Logo
Become a Client

Trackers and Spending Guides API

The core endpoints of the Query Tool API v3 are summarized here (with details in subsequent sections):

  • GET /api/v3/exports – List available exports. Returns a list of all data exports available to your account at the time of the request (including pre-generated full dataset exports and any custom exports you’ve triggered).
  • GET /api/v3/exports/{exportId}/files/{fileId} – Download a specific file. Each export can contain one or more file parts; this endpoint downloads a file (GZIP CSV) given an export ID and file ID. (Note: the file URLs provided in the exports list are the same endpoints).
  • GET /api/v3/products – List available products. Returns metadata for each product (data product) you have access to, including the latest version ID, product name, and publication date. Use this to discover Version IDs for advanced queries.
  • GET /api/v3/products/{versionId}/dimensions – Get dimensions for a product. Returns a list of dimension names for the given product version (e.g., [“Region”, “Year”, “Vendor”, …]).
  • GET /api/v3/products/{versionId}/measures – Get measures for a product. Returns a list of measure names (metrics) for the product version (e.g., [“Units”, “Value”, …]).
  • GET /api/v3/products/{versionId}/currencies – Get supported currencies. Returns a list of currency names or codes available for the product (if currency conversion is supported). If empty or not used, USD is default.
  • GET /api/v3/products/{versionId}/dimensions/{dimensionName}/values – Get valid values for a dimension. Returns a list of all values for a given dimension, for that product version (e.g., all years available). This helps in constructing filters for queries. This functionality is limited to time-dimensions only (e.g., Quarter, Year, etc., depending on product’s granularity).
  • POST /api/v3/exports – Register a custom export (Advanced Integration). Accepts a JSON body defining a query (selected dimensions, measures, filters, currency) and a Version ID, and initiates an export job. Returns an exportId and initial status.
  • GET /api/v3/exports/{exportId} – Check export status. Returns the status and metadata of a specific export (including file URLs if ready).