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 Calls"
10           },
11           {
12             "calls": 45,
13             "key": "batch",
14             "label": "Batch Requests"
15           }
16         ],
17         "lastRunAt": "2024-04-26T14:45:00Z",
18         "syncId": "a3f1c9d2-7b4e-4f9a-9c3d-2e5b7f8a1c2d",
19         "syncName": "Daily Customer Sync",
20         "syncType": "model",
21         "totalCalls": 165
22       },
23       {
24         "categories": [
25           {
26             "calls": 80,
27             "key": "rest",
28             "label": "REST API Calls"
29           }
30         ],
31         "lastRunAt": "2024-04-26T13:00:00Z",
32         "syncId": "b7d9e8f3-5a6c-4d2e-8f1b-3c4d5e6f7a8b",
33         "syncName": "Inventory Bulk Update",
34         "syncType": "bulk",
35         "totalCalls": 80
36       }
37     ],
38     "callsLast24h": 245,
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.

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