Skip to main content
Use this endpoint to retrieve call performance metrics scoped to a single agent in your Shilo organization. The data mirrors what appears in the per-agent insights view in the Shilo web app. You can identify the agent using their Shilo UUID, a prefixed UUID, or your own external_user_id, giving you flexibility when querying from your CRM or other internal systems.

Endpoint

Authentication

Include your API key in the request header:

Path Parameters

string
required
Identifies the agent to retrieve metrics for. Accepted formats:
  • id:{uuid} — prefixed Shilo UUID (e.g. id:ee6f2136-b94a-4438-9335-3acf5b2a0d31)
  • external_user_id:{string} — your system’s user ID (e.g. external_user_id:usr_abc123)
  • {uuid} — bare Shilo UUID (e.g. ee6f2136-b94a-4438-9335-3acf5b2a0d31)

Query Parameters

string
Inclusive lower date bound as an ISO date or date-time. Date-only values use UTC start of day. Defaults to UTC start of day 29 days ago. Example: 2026-03-26T00:00:00Z.
string
Inclusive upper date bound as an ISO date or date-time. Date-only values use UTC end of day. Defaults to the request time. Example: 2026-04-24T18:30:00Z.
string
Comma-separated list of source IDs to filter by. Example: source-1,source-2.
string
Comma-separated list of pipeline stage IDs to filter by. Example: stage-1,stage-2.
string
Comma-separated list of team IDs to filter by. Example: team-1,team-2.
string
default:"all"
Filter by call direction. Accepted values: all, inbound, outbound.

Response

200 — Success

Returns a Metrics object with aggregated performance data for the specified agent. The fields mirror the calculations shown in the per-agent insights view in the Shilo web app.

400 — Bad Request

One or more query parameters are invalid, or the identifier format is not recognized.

401 — Unauthorized

Your API key is missing or invalid.

404 — Not Found

No user matching the provided identifier was found in your organization.

Example Request