Skip to main content
Effective Date — May 7, 2026
As part of the IAM hierarchy simplification, a new format of the TIR APIs is now available. All endpoints that previously included /teams/:team_id segment will now follow a service-centric structure, with project_id now passed as a query parameter instead of a path segment. You can read more about this change

Metrics Summary

Returns an aggregated summary of all metrics for the gateway over the given interval.

GET/gateway/{gateway_id}/metrics_summary/

Path parameters

  • gateway_idPathintegerrequired

    Gateway ID

Query parameters

  • project_idQueryintegerrequired

    Project ID

  • locationQuerystringrequired

    Location

  • active_iamQueryintegeroptional

    Active IAM ID (To access contact person account) Find your Active IAM ID here

  • intervalQuerystringoptional

    Time window for metric aggregation.

Responses

200Aggregated metrics summary for the gateway.
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess