API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/carriers/{carrierId}/review-metrics

ark.get_carrier_review_metrics

Returns the current average rating, review count, and on-time performance metrics for a visible carrier.

Availability: Core preview
Scopes: carriers:read
ARK permissions: canViewCarriers
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

carrierIdpathstringrequired: Visible ARK carrier ID.; format: uuid

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/carriers/<carrierId>/review-metrics' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

OK

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.carrierIdstringrequired

format: uuid

data.carrierobjectrequired

data.metricsobjectrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found