Retrieve Site Search Usage and Limits

Updated

Use the Usage Extended API to retrieve monthly usage for your SearchStax Site Search account and per-app usage details.

Authentication

Headers

NameTypeDescription
AuthorizationstringToken <token>

Get Usage for a Month

Endpoint

GET https://app.searchstax.com/api/rest/v2/account/<account_name>/usage-extended/<year>/<month>/

Path Parameters

NameTypeDescription
account_namestringYour account name.
yearintegerFour-digit year, for example 2026.
monthintegerMonth number from 1 to 12.

Rate limit: 1 request every 3 seconds.

Note: The account is specified in the path, so you don't need an ?account= query parameter.

Request

Use this curl example to retrieve usage for a month:

curl -s \
  -H "Authorization: Token <token>" \
  "https://app.searchstax.com/api/rest/v2/account/<account_name>/usage-extended/<year>/<month>/"

Use this PowerShell example to call the endpoint with an authorization header:

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Authorization", "Token <token>")

$RESULTS = Invoke-RestMethod -Method Get -Headers $headers `
  -uri "https://app.searchstax.com/api/rest/v2/account/<account_name>/usage-extended/<year>/<month>/"

$RESULTS | ConvertTo-Json

Response

The response looks like this (abridged):

[
  {
    "SKU": "ST-24-PREMIUM",
    "amount": 0,
    "appsInfo": [
      {
        "createdDate": "2025-08-27T18:55:11Z",
        "deletedDate": null,
        "name": "app_alpha",
        "status": "Active",
        "totalItems": 500,
        "totalRequests": 145
      },
      {
        "createdDate": "2025-09-15T16:26:09Z",
        "deletedDate": null,
        "name": "app_beta",
        "status": "Active",
        "totalItems": 20,
        "totalRequests": 0
      }
    ],
    "contractEndDate": "2026-06-27T00:56:00Z",
    "contractStatus": "active",
    "currency": "USD",
    "displayMaxItems": 500000,
    "displayMaxRequests": 1000000,
    "endDate": "2025-12-31T23:59:59Z",
    "maxAllowedItems": 500000,
    "maxAllowedRequests": 1000000,
    "maxAppsAllowed": 7,
    "startDate": "2025-12-01T00:00:00Z",
    "tagCollection": []
  }
]

Interpret Usage Data

  • Per-app usage: appsInfo[].totalRequests and appsInfo[].totalItems.
  • Limits: Compare totals against maxAllowedRequests and maxAllowedItems.
  • Contract context: Use contractStatus and contractStartDate.
Articles in this section