Get Connection Usage

GET

https://app.polytomic.com/api/connections/:id/usage

GET

/api/connections/:id/usage

$ curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/usage \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "data": {
3     "bySync": [
4       {
5         "categories": [
6           {
7             "calls": 120,
8             "key": "rest",
9             "label": "REST API"
10           },
11           {
12             "calls": 45,
13             "key": "bulk",
14             "label": "Bulk API"
15           }
16         ],
17         "lastRunAt": "2024-04-26T14:45:00Z",
18         "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
19         "syncName": "Daily Salesforce Sync",
20         "syncType": "bulk",
21         "totalCalls": 165
22       },
23       {
24         "categories": [
25           {
26             "calls": 30,
27             "key": "rest",
28             "label": "REST API"
29           }
30         ],
31         "lastRunAt": "2024-04-26T10:15:00Z",
32         "syncId": "a3f9c1d2-5b7e-4f3a-9c2d-1e2f3a4b5c6d",
33         "syncName": "Hourly Contact Sync",
34         "syncType": "model",
35         "totalCalls": 30
36       }
37     ],
38     "callsLast24h": 195,
39     "connectionId": "248df4b7-aa70-47b8-a036-33ac447e668d",
40     "reportsSyncStats": true
41   }
42 }

Returns the connection’s API consumption over the last 24 hours, broken down by sync when the backend supports it.

Not all integrations support usage reporting.

callsLast24h is null when the backend does not expose a usage count.
reportsSyncStats is false, and bySync is empty, when the backend reports a total but cannot attribute calls to individual syncs.

When per-sync stats are available, each entry in bySync carries a categories breakdown. Category keys and labels are integration-specific. For example, Salesforce reports rest and bulk categories (collapsing Bulk API v1 and v2 into a single bulk bucket), while another integration may report an entirely different set or none at all. Treat key as an opaque, backend-defined identifier and use label for display; do not assume a fixed vocabulary across connection types.

Returns the connection's API consumption over the last 24 hours, broken down by sync when the backend supports it. Not all integrations support usage reporting. - `callsLast24h` is null when the backend does not expose a usage count. - `reportsSyncStats` is `false`, and `bySync` is empty, when the backend reports a total but cannot attribute calls to individual syncs. When per-sync stats are available, each entry in `bySync` carries a `categories` breakdown. **Category keys and labels are integration-specific.** For example, Salesforce reports `rest` and `bulk` categories (collapsing Bulk API v1 and v2 into a single `bulk` bucket), while another integration may report an entirely different set or none at all. Treat `key` as an opaque, backend-defined identifier and use `label` for display; do not assume a fixed vocabulary across connection types.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the connection whose API consumption should be returned.

Response

dataobject

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors