Get a call analysis

get

https://api.emaktalk.com/api/v2/call_records/{id}/analyses/{kind}

Returns one analysis of a call, whole, by its kind (a key of the record's analyses).

Response: { data }: state, generated_at, model, schema, headline (when the kind has one), the kind's own data and etag. data is null while the state is not done.

Notes:

No analysis kind is available yet: until one is turned on for your account, every call's analyses is {} and this endpoint answers 404.
schema=<kind>/<n> reads an older data shape the kind still serves; the answer's schema says which shape you got.
An unknown kind, a kind not enabled for your account and a kind this call lacks all answer the same 404, whatever schema says.
Cache by ETag: send it back as If-None-Match, and an analysis you already hold answers 304.
Needs access to the call's content (403 content_forbidden otherwise).
HEAD answers the same status and headers with no body.

Logged: nothing. Analyses are never recorded in the access log.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The call record's id (a record's id).

kind

string

required

The analysis kind, a key of the record's analyses: insights, or a plug-in kind named x-<owner>.<name>.

Query Params

schema

string

Read the analysis in an older data shape the kind still serves, as <kind>/<n> (for example insights/1). Default: the kind's current shape. For a kind the call has, a value that is not <this kind>/<n>, or a shape the kind does not serve, answers 400 parameter_invalid (details.allowed lists the shapes it serves). A kind the call does not have answers 404 whatever schema says.

account_id

uuid

The one account to read, by its id (account.id). Only a caller that may choose the account (EMAK support) sends it, and must; everyone else reads the account they belong to. Absent for a caller that must name it: 400 parameter_missing. Empty or not an account id: 400 parameter_invalid. Given twice: 400 parameter_invalid for any caller. Sent by a caller that reads its own account: 403 forbidden. An account that does not exist or is disabled: 404 reference_not_found. Each names account_id in param. The account is named this way only: a request that sends the legacy account header X-Tenant-Domain-Uuid is refused (400 parameter_unknown).

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200The analysis, whole, in its current schema or the one you asked for: { data }. data inside it is null while the state is not done.

304Your copy is current: the If-None-Match you sent names the analysis' current tag. No body.

403 forbidden: the caller may not read this account's call history, or sent account_id without being allowed to choose an account. content_forbidden: the caller may see this call's details but not read its analyses.

405This path doesn't answer this method (method_not_allowed); the Allow header lists the ones it does: GET, HEAD on the reads; GET, HEAD, DELETE on a recording; POST on undelete and batch_delete.

429Too many requests (rate_limited). Wait retry_after_sec seconds (the Retry-After header), then retry the same request.

500Something failed on our side (internal), and nothing was handed over. Quote request_id when you report it.

503A temporary condition (try_again): the service is briefly busy, or the call's content changed while it was being read, so nothing was handed over. Wait retry_after_sec seconds (the Retry-After header), then retry.