For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
SupportLog InSign Up
GuidesAPI Reference
GuidesAPI Reference
  • Tax Rates
    • GETGet Tax Rates (v6.0)
  • Merchant
    • POSTCreate Merchant
    • POSTUpdate Merchant
    • POSTDelete Merchant
    • POSTGet Merchant
    • GETList Merchants
    • POSTSet Merchant Credentials
    • POSTGet Merchant Credentials
    • POSTDelete Merchant Credentials
  • Data
    • GETGet TIC Codes
  • System
    • GETHealth Check
    • GETGet System Metadata
  • Ziptax API
      • GETGet Account Metrics
SupportLog InSign Up
Ziptax APIAccount

Get Account Metrics

GET
https://api.ziptax.com/account/metrics
GET
/account/metrics
$curl -G https://api.ziptax.com/account/metrics \
>     -H "X-API-KEY: <apiKey>" \
>     -d key=key
1{
2  "core_request_count": 1000000,
3  "core_request_limit": 1000000,
4  "core_usage_percent": 1.1,
5  "geo_enabled": true,
6  "geo_request_count": 1000000,
7  "geo_request_limit": 1000000,
8  "geo_usage_percent": 1.1,
9  "is_active": true,
10  "last_updated": "2024-01-15T09:30:00Z"
11}
Returns usage metrics for the authenticated account
Was this page helpful?
Previous
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Query parameters

keystringOptional10-100 characters
API key for authentication

Response

OK
core_request_countlong
Core request count
core_request_limitlong
Core request limit
core_usage_percentdouble
Core usage percentage
geo_enabledboolean
Geo features enabled
geo_request_countlong
Geo request count
geo_request_limitlong
Geo request limit
geo_usage_percentdouble
Geo usage percentage
is_activeboolean
Account active status
last_updateddatetime
Last update timestamp

Errors

401
Get Account Metrics Request Unauthorized Error
422
Get Account Metrics Request Unprocessable Entity Error
500
Get Account Metrics Request Internal Server Error