> ## Documentation Index > Fetch the complete documentation index at: https://docs.isnap.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the activity of a trial > Returns the status of a trial, its message counts and the sends left before it becomes dormant. * **Credential:** the trial key of the trial, and no other credential: an API key returns `401 unauthorized`. See [Trial key](/guides/trials#trial-key). * **Events:** none. * **Personal data:** `paired_handle`, the prospect's phone number or the email address of their Apple ID. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a prospect by an id of your own. * **Counters:** `messages_sent_total` and `messages_received_total` count the messages of the trial that iSnap still keeps, not the life of the trial: see [Activity](/guides/trials#activity). ## Errors | Status | `error.code` | When | | - | - | - | | 401 | `unauthorized` | The credential is an API key, or the key of a revoked or unknown trial. | | 404 | `trial_not_active` or `trial_not_found` | The trial was revoked while the request was running. | The errors that every operation shares are in [Errors](/errors-and-rate-limits#errors). ## OpenAPI ````yaml GET /v1/trial/activity openapi: 3.0.0 info: title: iSnap API version: 2.45.0 description: >- The iSnap API sends and receives iMessage, RCS and SMS on real phone lines, manages those lines, and reports events through webhooks. Every message is sent to a real recipient, with an `isnap_live_` key and with an `isnap_test_` key alike. Retry a `429` after `Retry-After` seconds. Retry a `500` or a `503` up to 2 times, with exponential backoff. Do not retry any other `4xx`: fix the request. Retry a write only on an operation that honors `Idempotency-Key`, with the key of the first attempt. Responses carry personal data: handles, names and message text. servers: - url: https://api.isnap.ai security: - bearerAuth: [] paths: /v1/trial/activity: get: summary: Get the activity of a trial description: >- Returns the status and the message counts of the trial that the trial key belongs to. Accepts a trial key only: an API key is refused with `401`. `status` is `active` or `dormant`. A trial becomes `dormant` when `outbound_since_last_inbound` reaches `max_outbound_without_inbound`: the send that reaches the limit succeeds, and the next ones return `402 trial_needs_inbound`. A message from the prospect, a reaction that the prospect adds to a message of the trial, or the first read receipt on a message of the trial resets `outbound_since_last_inbound` to 0 and makes a dormant trial `active` again. When the trial runs on an iMessage line, a read by the prospect does not count: it neither resets `outbound_since_last_inbound` nor makes a dormant trial `active` again. Dormancy depends on this count only: no timer makes a trial dormant or ends it. `messages_sent_total` and `messages_received_total` count the messages that iSnap still keeps, not the whole life of the trial: iSnap deletes a message at least 72 hours after it recorded it. `paired_handle` is the handle of the prospect: this is personal data. responses: '200': description: The status and the counts of the trial. content: application/json: schema: $ref: '#/components/schemas/TrialActivityEnvelope' '400': description: >- Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: >- No valid credential. `error.code` is `unauthorized`. An API key is refused here: the operation accepts a trial key only. The key of a revoked trial is refused too. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: >- Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '500': description: >- Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' security: - bearerAuth: [] components: schemas: TrialActivityEnvelope: type: object properties: success: type: boolean enum: - true description: Always `true` on a success response. data: $ref: '#/components/schemas/TrialActivityData' trace_id: type: string description: >- Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. request_id: type: string description: >- Id of the request that produced this response: `req_` followed by 25 letters or digits. required: - success - data - trace_id - request_id ErrorEnvelope: type: object properties: success: type: boolean enum: - false description: Always `false` on an error response. data: nullable: true description: Always `null` on an error response. error: type: object properties: status: type: integer description: The HTTP status of the response. code: type: string description: >- Stable machine-readable code that names the refusal. Branch on this value. message: type: string description: >- Text for a person. It can change between versions: do not branch on it. retry_after: type: integer nullable: true description: >- Seconds to wait before the next attempt. Set on the `429` responses that know a delay, where the `Retry-After` header carries the same value. When it is above 60 seconds, do not wait in a request: schedule the call, or report the time. `null` on every other error. retry_at: type: string nullable: true description: >- ISO 8601 timestamp at which the refusal ends. Set only on `429 rebind_cap_reached`. `null` on every other error. issues: type: array nullable: true items: type: object properties: path: type: array items: anyOf: - type: string - type: number description: >- Where the problem is: the field names and array indexes that lead to it. message: type: string description: Text for a person. code: type: string description: >- Kind of problem. On `validation_failed`, for example `invalid_type`, `invalid_value`, `invalid_format`, `invalid_union`, `invalid_key`, `invalid_element`, `too_small`, `too_big`, `not_multiple_of`, `unrecognized_keys` or `custom`. The list is open: read `path` and `message`. min: type: integer description: >- Smallest accepted value. Present only on `limit_out_of_bounds`, `mac_quantity_not_a_pack`, `byop_reduction_strands_mac_sessions` and `byop_reduction_strands_byod_lines`. max: type: integer description: >- Largest accepted value. Present only on `limit_out_of_bounds` and `mac_sessions_exceed_byop_lines`, and on the `too_big` issue of an `Idempotency-Key` header longer than 255 characters. required: - path - message - code description: >- Problems found in the request, one entry each. Set on most `400 validation_failed` responses and on the refusals that name a field: a refused `handle` of `POST /v1/lookup` has `issues: null`. `null` on every other error. required: - status - code - message - retry_after - retry_at - issues description: >- What went wrong. The six fields are always present; `retry_after`, `retry_at` and `issues` are `null` when they do not apply. trace_id: type: string description: >- Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. request_id: type: string description: >- Id of the request that produced this response: `req_` followed by 25 letters or digits. required: - success - data - error - trace_id - request_id description: The body of an error response. TrialActivityData: type: object properties: trial_id: type: string description: 'Id of the trial: `trl_` followed by 25 letters or digits.' pool_line_id: type: string description: >- Id of the line the trial runs on (`line_`). The trial key sends from this line only. paired_handle: type: string description: >- Handle of the prospect: the only recipient the trial key can send to. Personal data. status: type: string enum: - active - dormant description: >- `active`: the trial key can send. `dormant`: sends return `402 trial_needs_inbound` until the prospect replies, adds a reaction or reads a message. When the trial runs on an iMessage line, a read does not count. last_inbound_at: type: string nullable: true description: >- Timestamp of the latest message received from the prospect that iSnap still keeps. `null` when there is none. last_activity_at: type: string nullable: true description: >- Timestamp of the latest of these: the pairing, a send, or a reply, a reaction or a read receipt from the prospect. When the trial runs on an iMessage line, a read does not count. messages_sent_total: type: integer description: >- Number of messages sent with the trial key that iSnap still keeps. iSnap deletes a message at least 72 hours after it recorded it: this is not a total over the life of the trial. messages_received_total: type: integer description: >- Number of messages received from the prospect that iSnap still keeps. iSnap deletes a message at least 72 hours after it recorded it: this is not a total over the life of the trial. activity_rule: type: object properties: max_outbound_without_inbound: type: integer description: >- Number of messages the trial key can send in a row without a reply, a reaction or a read receipt from the prospect. outbound_since_last_inbound: type: integer description: >- Messages sent with the trial key since the last reply, reaction or read receipt from the prospect. The trial becomes `dormant` when this number reaches `max_outbound_without_inbound`. remaining_before_dormant: type: integer description: >- Number of sends left before the trial becomes `dormant`: `max_outbound_without_inbound` minus `outbound_since_last_inbound`, never below 0. required: - max_outbound_without_inbound - outbound_since_last_inbound - remaining_before_dormant description: >- The limit on messages sent without a reply, and where the trial stands against it. When the trial runs on an iMessage line, a read by the prospect does not count: only a reply or a reaction does. required: - trial_id - pool_line_id - paired_handle - status - last_inbound_at - last_activity_at - messages_sent_total - messages_received_total - activity_rule description: The status and the message counts of a trial. securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key created in the iSnap dashboard, or a trial key, sent as `Authorization: Bearer `. An API key starts with `isnap_live_` or `isnap_test_`; both act on the same account, lines and billing. A trial key acts on its trial only. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.