Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Connections

Get Connection Usage

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.

get/api/connections/{id}/usage

Path parameters

idstring uuid required

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

Example:248df4b7-aa70-47b8-a036-33ac447e668d

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

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "bySync": [
      {
        "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d"
      }
    ],
    "connectionId": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}