Integrations

Get an integration's metrics and sync status

This route allows you to get a specific integration's metrics and sync status either the latest one or for a specific resync.<br/><br/>It returns the sync's execution status and detailed metrics per kind for each phase of the sync.<br/> For example, the number of fetched objects in the sync's fetch phase, number of objects that were mapped in the mapping phase, etc.<br/><br/>To learn more about integrations, check out the documentation. <br></br><br></br> Non-existent integration ID: If the provided integrationInternalId does not match any existing integration, the endpoint will return a 200 OK response with empty results.<br/><br/> Permission requirements<br/>To use this endpoint, you must have a moderator or admin role in your Port organization.<br/>To learn more about the different roles and permissions, please refer to the documentation.

get/v1/integration/{integrationInternalId}/syncMetrics

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/integration/{integrationInternalId}/syncMetrics
  • Auth: API key in header Authorization

Path parameters

integrationInternalIdstring required

The ID of the integration you want to operate on.

Query parameters

resyncIdstring

The ID of a specific resync. If this field is left empty, the latest resync data will be returned.

Response

Default Response

okboolean required
countnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.