Key identity and rate limit | Siftsy Analyst API

{
  "data": {
    "teamId": "team_2f8c1a",
    "scopes": [
      "posts:read",
      "comments:read",
      "insights:read",
      "analyses:read",
      "analyses:run",
      "collections:read",
      "team:read"
    ],
    "key": {
      "id": "key_01j9x",
      "keyId": "k_7b3d",
      "keyPrefix": "sk_live_7b3d",
      "name": "Warehouse loader"
    },
    "rateLimit": {
      "remainingRequests": 299,
      "remainingDailyRequests": 9412,
      "remainingBytes": 498073600,
      "limitPerMinute": 300,
      "limitPerDay": 10000,
      "dailyBytesLimit": 524288000,
      "routeClasses": {
        "comments": {
          "perMinute": 120,
          "perDay": 1000
        },
        "analysis_comments": {
          "perMinute": 20,
          "perDay": 300
        },
        "collection_posts": {
          "perMinute": 60,
          "perDay": 1000
        },
        "analysis_read": {
          "perMinute": 60,
          "perDay": 2000
        },
        "analysis_create": {
          "perMinute": 10,
          "perDay": 100
        },
        "analysis_search": {
          "perMinute": 2,
          "perDay": 10
        }
      }
    }
  },
  "meta": {}
}

Team id, scopes, key metadata, and the key’s current rate-limit position: rateLimit.remainingRequests (this minute), remainingDailyRequests, remainingBytes, the global caps, and routeClasses with each class’s per-minute / per-day budget. Check this before a scheduled sync and skip a full refresh when the day’s budget is mostly spent.

Team id, scopes, key metadata, and the key's current rate-limit position: `rateLimit.remainingRequests` (this minute), `remainingDailyRequests`, `remainingBytes`, the global caps, and `routeClasses` with each class's per-minute / per-day budget. Check this before a scheduled sync and skip a full refresh when the day's budget is mostly spent.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Api-Keystring

API Key authentication via header

Response

Current API key context

dataobjectOptional

metaobjectOptional

Errors

401

Unauthorized Error