> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Read team analytics > Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline. Requires `sessions:read`. Project tokens only access resources in their own project. ## OpenAPI ````yaml api-reference/features/operations.json GET /platform/analytics openapi: 3.0.3 info: title: Operations API methods version: 1.0.0 description: Task-focused operations methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/analytics: get: tags: - Analytics summary: Read team analytics description: >- Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline. Requires `sessions:read`. Project tokens only access resources in their own project. operationId: managementGetWhatsAppAnalytics parameters: - name: projectId in: query required: false description: Project to read. Omit to total every project in the organization. schema: type: string - name: sessionId in: query required: false schema: type: string format: uuid description: Number record UUID. description: |- Identifier of the connected Polymorfa session. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | - name: start in: query required: false schema: type: integer minimum: 0 description: Unix milliseconds; maximum range 366 days. description: |- Specifies start for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | - name: end in: query required: false schema: type: integer minimum: 0 description: Unix milliseconds; maximum range 366 days. description: |- Specifies end for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | responses: '200': description: Success headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: type: object additionalProperties: false properties: data: allOf: - $ref: '#/components/schemas/management__WhatsAppAnalytics' description: Structured data carried by this object. required: - data '400': $ref: '#/components/responses/management__BadRequest' '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' '404': $ref: '#/components/responses/management__NotFound' '503': $ref: '#/components/responses/management__PropagationPending' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com components: schemas: management__WhatsAppAnalytics: type: object additionalProperties: false properties: enabled: type: boolean description: Whether this feature is enabled. period: type: object additionalProperties: false properties: start: type: integer description: Unix milliseconds. end: type: integer description: Unix milliseconds. required: - start - end description: Structured period values for this management whats app analytic. requestVitals: type: object additionalProperties: false properties: requests: type: integer minimum: 0 description: |- Specifies requests for this request vital. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failures: type: integer minimum: 0 description: |- Specifies failures for this request vital. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | errorRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies error rate for this request vital. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | required: - requests - failures - errorRate description: >- Structured request vitals values for this management whats app analytic. summary: type: object nullable: true allOf: - type: object additionalProperties: false properties: measured: type: boolean description: Whether measured. observedHours: type: integer minimum: 0 description: |- Specifies observed hours for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastObservedAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true outgoingMessages: type: integer minimum: 0 description: |- Specifies outgoing messages for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | incomingMessages: type: integer minimum: 0 description: |- Specifies incoming messages for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendAttempts: type: integer minimum: 0 description: |- Specifies send attempts for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailures: type: integer minimum: 0 description: |- Specifies send failures for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailureRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies send failure rate for this all of. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | businessReplies: type: integer minimum: 0 description: |- Specifies business replies for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageBusinessResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average business response ms for this all of. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | onlineMs: type: integer minimum: 0 description: |- Specifies online ms for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | disconnects: type: integer minimum: 0 description: |- Specifies disconnects for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | connectFailures: type: integer minimum: 0 description: |- Specifies connect failures for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | streamErrors: type: integer minimum: 0 description: |- Specifies stream errors for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | keepaliveTimeouts: type: integer minimum: 0 description: |- Specifies keepalive timeouts for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | engagement: type: object additionalProperties: false properties: windowHours: type: integer enum: - 24 description: |- Specifies window hours for this engagement. **Allowed values** | Value | Meaning | | --- | --- | | `24` | 24. | completedConversations: type: integer minimum: 0 description: |- Specifies completed conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveredConversations: type: integer minimum: 0 description: |- Specifies delivered conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readConversations: type: integer minimum: 0 description: |- Specifies read conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | repliedConversations: type: integer minimum: 0 description: |- Specifies replied conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveryRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies delivery rate for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | readRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies read rate for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | replyRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies reply rate for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageCustomerReplyMs: type: number minimum: 0 nullable: true description: >- Specifies average customer reply ms for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | complete: type: boolean description: Whether complete. droppedConversations: type: integer minimum: 0 description: |- Specifies dropped conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedRecords: type: integer minimum: 0 description: |- Specifies dropped records for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedReceiptJoins: type: integer minimum: 0 description: |- Specifies dropped receipt joins for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - windowHours - completedConversations - deliveredConversations - readConversations - repliedConversations - deliveryRate - readRate - replyRate - averageCustomerReplyMs - complete - droppedConversations - droppedRecords - droppedReceiptJoins description: Structured engagement values for this all of. totalNumbers: type: integer minimum: 0 description: |- Specifies total numbers for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | measuredNumbers: type: integer minimum: 0 description: |- Specifies measured numbers for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | connectedNumbers: type: integer minimum: 0 description: |- Specifies connected numbers for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | messageAnalysis: type: object additionalProperties: false properties: complete: type: boolean description: Whether complete. segments: type: array items: type: object additionalProperties: false properties: dimension: type: string enum: - message_type - text_band - origin - calling_code - customer_devices description: |- Specifies dimension for this segment. **Allowed values** | Value | Meaning | | --- | --- | | `message_type` | Message type. | | `text_band` | Text band. | | `origin` | Origin. | | `calling_code` | Calling code. | | `customer_devices` | Customer devices. | key: type: string description: Specifies key for this segment. sendAttempts: type: integer minimum: 0 description: |- Specifies send attempts for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sent: type: integer minimum: 0 description: |- Specifies sent for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailures: type: integer minimum: 0 description: |- Specifies send failures for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailureRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies send failure rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | completedConversations: type: integer minimum: 0 description: >- Specifies completed conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveredConversations: type: integer minimum: 0 description: >- Specifies delivered conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readConversations: type: integer minimum: 0 description: |- Specifies read conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | repliedConversations: type: integer minimum: 0 description: |- Specifies replied conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveryRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies delivery rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | readRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies read rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | replyRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies reply rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageCustomerReplyMs: type: number minimum: 0 nullable: true description: >- Specifies average customer reply ms for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shareOfConversations: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share of conversations for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | shareOfSends: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share of sends for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | readRateInterval95: type: array nullable: true minItems: 2 maxItems: 2 items: type: number minimum: 0 maximum: 1 description: >- 95% Wilson interval for observed conversation receipts or replies; not a causal effect. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `array`; Array size: `2` through `2` items; Item numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `2` through `2` items | | Item numeric value | `0` through `1` (inclusive) | replyRateInterval95: type: array nullable: true minItems: 2 maxItems: 2 items: type: number minimum: 0 maximum: 1 description: >- 95% Wilson interval for observed conversation receipts or replies; not a causal effect. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `array`; Array size: `2` through `2` items; Item numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `2` through `2` items | | Item numeric value | `0` through `1` (inclusive) | readRateDifference: type: number minimum: -1 maximum: 1 nullable: true description: >- Specifies read rate difference for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `-1` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `-1` through `1` (inclusive) | replyRateDifference: type: number minimum: -1 maximum: 1 nullable: true description: >- Specifies reply rate difference for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `-1` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `-1` through `1` (inclusive) | required: - dimension - key - sendAttempts - sent - sendFailures - sendFailureRate - completedConversations - deliveredConversations - readConversations - repliedConversations - deliveryRate - readRate - replyRate - averageCustomerReplyMs - shareOfConversations - shareOfSends - readRateInterval95 - replyRateInterval95 - readRateDifference - replyRateDifference description: Segments associated with this message analysi. required: - complete - segments description: Structured message analysis values for this all of. customerActivity: type: object additionalProperties: false properties: observed: type: boolean description: Whether observed. onlineSignals: type: integer minimum: 0 description: |- Specifies online signals for this customer activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | offlineSignals: type: integer minimum: 0 description: |- Specifies offline signals for this customer activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | typingSignals: type: integer minimum: 0 description: |- Specifies typing signals for this customer activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - observed - onlineSignals - offlineSignals - typingSignals description: Structured customer activity values for this all of. accountActivity: type: object additionalProperties: false properties: observed: type: boolean description: Whether observed. primaryPhoneActivitySignals: type: integer minimum: 0 description: >- Specifies primary phone activity signals for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | primaryPhoneActivePeriods: type: integer minimum: 0 description: >- Specifies primary phone active periods for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | completedPhoneActivityPeriods: type: integer minimum: 0 description: >- Specifies completed phone activity periods for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneActivityMs: type: integer minimum: 0 description: |- Specifies phone activity ms for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePhoneActivityMs: type: number minimum: 0 nullable: true description: >- Specifies average phone activity ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneQuietGaps: type: integer minimum: 0 description: |- Specifies phone quiet gaps for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneQuietMs: type: integer minimum: 0 description: |- Specifies phone quiet ms for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePhoneQuietMs: type: number minimum: 0 nullable: true description: >- Specifies average phone quiet ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | primaryPhoneMessages: type: integer minimum: 0 description: >- Specifies primary phone messages for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | otherDeviceMessages: type: integer minimum: 0 description: >- Specifies other device messages for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastPrimaryPhoneAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true primaryPhoneReplies: type: integer minimum: 0 description: >- Specifies primary phone replies for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | otherDeviceReplies: type: integer minimum: 0 description: >- Specifies other device replies for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePrimaryPhoneResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average primary phone response ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageOtherDeviceResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average other device response ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - observed - primaryPhoneActivitySignals - primaryPhoneActivePeriods - completedPhoneActivityPeriods - phoneActivityMs - averagePhoneActivityMs - phoneQuietGaps - phoneQuietMs - averagePhoneQuietMs - primaryPhoneMessages - otherDeviceMessages - lastPrimaryPhoneAt - primaryPhoneReplies - otherDeviceReplies - averagePrimaryPhoneResponseMs - averageOtherDeviceResponseMs description: Structured account activity values for this all of. responseQueue: type: object nullable: true allOf: - type: object additionalProperties: false properties: awaitingReply: type: integer minimum: 0 description: |- Specifies awaiting reply for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | oldestWaitingMs: type: integer minimum: 0 description: |- Specifies oldest waiting ms for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | observedAt: type: integer description: Unix milliseconds. complete: type: boolean description: Whether complete. required: - awaitingReply - oldestWaitingMs - observedAt - complete description: >- Structured response queue values for this all of. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `awaitingReply`, `oldestWaitingMs`, `observedAt`, `complete` | | Alternative 2 | `null` | calls: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | directions: type: object additionalProperties: false properties: inbound: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video description: Structured inbound values for this direction. outbound: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video description: Structured outbound values for this direction. required: - inbound - outbound description: Structured directions values for this call. mediaQuality: type: object additionalProperties: false properties: measuredCalls: type: integer minimum: 0 description: |- Specifies measured calls for this media quality. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageJitterMs: type: number minimum: 0 nullable: true description: >- Specifies average jitter ms for this media quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageRttMs: type: number minimum: 0 nullable: true description: >- Specifies average rtt ms for this media quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | packetsLost: type: integer minimum: 0 nullable: true description: >- Specifies packets lost for this media quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - measuredCalls - averageJitterMs - averageRttMs - packetsLost description: Structured media quality values for this call. appQuality: type: object additionalProperties: false properties: measuredCalls: type: integer minimum: 0 description: |- Specifies measured calls for this app quality. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageJitterMs: type: number minimum: 0 nullable: true description: >- Specifies average jitter ms for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageRttMs: type: number minimum: 0 nullable: true description: >- Specifies average rtt ms for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | packetLossRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies packet loss rate for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | reconnects: type: integer minimum: 0 nullable: true description: >- Specifies reconnects for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - measuredCalls - averageJitterMs - averageRttMs - packetLossRate - reconnects description: Structured app quality values for this call. endReasons: type: array items: type: object additionalProperties: false properties: code: type: string description: Stable machine-readable code for this result. count: type: integer minimum: 0 description: |- Number of matching resources. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - code - count description: End reasons associated with this call. appErrors: type: array items: type: object additionalProperties: false properties: code: type: string description: Stable machine-readable code for this result. count: type: integer minimum: 0 description: |- Number of matching resources. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - code - count description: App errors associated with this call. transports: type: array items: type: object additionalProperties: false properties: code: type: string description: Stable machine-readable code for this result. count: type: integer minimum: 0 description: |- Number of matching resources. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - code - count description: Transports associated with this call. multiParticipantCalls: type: integer minimum: 0 description: |- Specifies multi participant calls for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | followUp: type: object additionalProperties: false properties: eligibleMissed: type: integer minimum: 0 description: |- Specifies eligible missed for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | returnedWithin24h: type: integer minimum: 0 description: |- Specifies returned within24h for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | rate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies rate for this follow up. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageDelayMs: type: number minimum: 0 nullable: true description: >- Specifies average delay ms for this follow up. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | pendingWindow: type: integer minimum: 0 description: |- Specifies pending window for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | unknownContact: type: integer minimum: 0 description: |- Specifies unknown contact for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - eligibleMissed - returnedWithin24h - rate - averageDelayMs - pendingWindow - unknownContact description: Structured follow up values for this call. required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video - directions - mediaQuality - appQuality - endReasons - appErrors - transports - multiParticipantCalls - followUp description: Structured calls values for this all of. deviceAnalytics: type: object additionalProperties: false properties: detector: type: string enum: - message_id_prefix/v1 description: |- Specifies detector for this device analytic. **Allowed values** | Value | Meaning | | --- | --- | | `message_id_prefix/v1` | Message id prefix/v1. | measured: type: boolean description: >- True when at least one retained bucket has client-family measurement coverage, including buckets with zero messages. complete: type: boolean description: >- True when measured is true, every retained bucket has device-family coverage and conversation receipt coverage is complete. False when coverage is missing or records, conversations or receipt joins were dropped. Inventory truncation is reported separately. observedBuckets: type: integer minimum: 0 description: |- Specifies observed buckets for this device analytic. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | customerMessages: type: integer minimum: 0 nullable: true description: >- Specifies customer messages for this device analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | accountMessages: type: integer minimum: 0 nullable: true description: >- Specifies account messages for this device analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | customerPlatforms: type: array items: type: object additionalProperties: false properties: platform: type: string enum: - web - android - iphone - ipad - macos - windows - wearable - ar_device - unknown description: >- Sending client family estimated from a message ID prefix; not verified hardware or operating system. **Allowed values** | Value | Meaning | | --- | --- | | `web` | Web client. | | `android` | Android client. | | `iphone` | iPhone client. | | `ipad` | iPad client. | | `macos` | macOS client. | | `windows` | Windows client. | | `wearable` | Wearable client. | | `ar_device` | AR device client. | | `unknown` | No recognized client-family prefix. | messages: type: integer minimum: 0 description: |- Specifies messages for this customer platform. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | share: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share for this customer platform. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | required: - platform - messages - share description: Customer platforms associated with this device analytic. accountPlatforms: type: array items: type: object additionalProperties: false properties: platform: type: string enum: - web - android - iphone - ipad - macos - windows - wearable - ar_device - unknown description: >- Sending client family estimated from a message ID prefix; not verified hardware or operating system. **Allowed values** | Value | Meaning | | --- | --- | | `web` | Web client. | | `android` | Android client. | | `iphone` | iPhone client. | | `ipad` | iPad client. | | `macos` | macOS client. | | `windows` | Windows client. | | `wearable` | Wearable client. | | `ar_device` | AR device client. | | `unknown` | No recognized client-family prefix. | messages: type: integer minimum: 0 description: |- Specifies messages for this account platform. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | share: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share for this account platform. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | required: - platform - messages - share description: Account platforms associated with this device analytic. inventory: type: object additionalProperties: false properties: listObserved: type: boolean description: >- True after a full device list for this number was observed. listCurrent: type: boolean description: >- True when a full list was observed and no later list-change signal invalidated it. Membership and device count are unknown until another full list after a change. observedAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true deviceCount: type: integer minimum: 0 nullable: true description: >- Number of devices. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | truncated: type: boolean description: >- True when the bounded inventory omitted devices. At most 25 device rows are returned; a current full-list device count can be larger. devices: type: array items: type: object additionalProperties: false properties: deviceIndex: type: integer minimum: 0 maximum: 999 description: >- Specifies device index for this device. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `999` (inclusive) | estimatedPlatform: type: string enum: - web - android - iphone - ipad - macos - windows - wearable - ar_device - unknown description: >- Sending client family estimated from a message ID prefix; not verified hardware or operating system. **Allowed values** | Value | Meaning | | --- | --- | | `web` | Web client. | | `android` | Android client. | | `iphone` | iPhone client. | | `ipad` | iPad client. | | `macos` | macOS client. | | `windows` | Windows client. | | `wearable` | Wearable client. | | `ar_device` | AR device client. | | `unknown` | No recognized client-family prefix. | reportedClass: type: string enum: - phone - desktop_app - browser - business_api - unknown description: >- Specifies reported class for this device. **Allowed values** | Value | Meaning | | --- | --- | | `phone` | Phone. | | `desktop_app` | Desktop app. | | `browser` | Browser. | | `business_api` | Business API. | | `unknown` | No recognized reported device class. | lastActiveAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true listed: type: boolean nullable: true description: >- Whether this device index belongs to the latest observed full list. Null when that list is no longer current. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `boolean` | | Alternative 2 | `null` | required: - deviceIndex - estimatedPlatform - reportedClass - lastActiveAt - listed maxItems: 25 description: |- Devices associated with this inventory. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `25` items | required: - listObserved - listCurrent - observedAt - deviceCount - truncated - devices nullable: true description: >- Structured inventory values for this device analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `listObserved`, `listCurrent`, `observedAt`, `deviceCount`, `truncated`, `devices` | | Alternative 2 | `null` | required: - detector - measured - complete - observedBuckets - customerMessages - accountMessages - customerPlatforms - accountPlatforms - inventory description: >- Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory. conversationBreakdown: type: object additionalProperties: false properties: measured: type: boolean description: >- True when at least one retained bucket includes joint conversation categories. complete: type: boolean description: >- True when measured is true, every retained bucket has joint conversation coverage, no conversation, record or receipt-join coverage was lost and the returned groups are not truncated. Rates and averages are null when false. observedBuckets: type: integer minimum: 0 description: >- Specifies observed buckets for this conversation breakdown. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedConversations: type: integer minimum: 0 description: >- Specifies dropped conversations for this conversation breakdown. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | truncated: type: boolean description: >- True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null. buckets: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. complete: type: boolean description: >- True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket. required: - ts - complete description: Buckets associated with this conversation breakdown. rows: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. messageType: type: string enum: - text - image - video - audio - document - sticker - interactive - template - other description: |- Category assigned to message. **Allowed values** | Value | Meaning | | --- | --- | | `text` | Text. | | `image` | Image. | | `video` | Video. | | `audio` | Audio. | | `document` | Document. | | `sticker` | Sticker. | | `interactive` | Interactive. | | `template` | Template. | | `other` | Other. | textBand: type: string enum: - none - short - medium - long - very_long - unknown description: |- Specifies text band for this row. **Allowed values** | Value | Meaning | | --- | --- | | `none` | None. | | `short` | Short. | | `medium` | Medium. | | `long` | Long. | | `very_long` | Very long. | | `unknown` | Unknown. | origin: type: string enum: - api - campaign - other description: |- Specifies origin for this row. **Allowed values** | Value | Meaning | | --- | --- | | `api` | API send. | | `campaign` | Campaign send. | | `other` | Other or unclassified send source. | recipientCountry: type: string pattern: ^(unknown|[A-Z]{2})$ description: >- Numbering country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^(unknown\|[A-Z]{2})$` | recipientDeviceCount: type: string enum: - primary_only - one_linked - two_plus_linked - unknown description: >- Observed linked-device range; device zero is the primary and is excluded from linked counts. **Allowed values** | Value | Meaning | | --- | --- | | `primary_only` | Primary only. | | `one_linked` | One linked. | | `two_plus_linked` | Two plus linked. | | `unknown` | Unknown. | callingCode: type: string pattern: ^(unknown|[1-9][0-9]{0,2})$ description: |- Machine-readable calling code for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^(unknown\|[1-9][0-9]{0,2})$` | customerDevices: type: string enum: - single - multiple - unknown description: |- Specifies customer devices for this row. **Allowed values** | Value | Meaning | | --- | --- | | `single` | Single. | | `multiple` | Multiple. | | `unknown` | Unknown. | completedConversations: type: integer minimum: 0 description: |- Specifies completed conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveredConversations: type: integer minimum: 0 description: |- Specifies delivered conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readConversations: type: integer minimum: 0 description: |- Specifies read conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | repliedConversations: type: integer minimum: 0 description: |- Specifies replied conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | replyLatencySumMs: type: integer minimum: 0 description: |- Specifies reply latency sum ms for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies read rate for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | replyRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies reply rate for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageCustomerReplyMs: type: number minimum: 0 nullable: true description: >- Specifies average customer reply ms for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - ts - messageType - textBand - origin - recipientCountry - recipientDeviceCount - callingCode - customerDevices - completedConversations - deliveredConversations - readConversations - repliedConversations - replyLatencySumMs - readRate - replyRate - averageCustomerReplyMs maxItems: 4096 description: |- Rows associated with this conversation breakdown. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `4096` items | required: - measured - complete - observedBuckets - droppedConversations - truncated - buckets - rows description: >- Completed 24-hour conversation cohorts grouped jointly by completion bucket, first outgoing message metadata, calling code and observed device-count class. recipientActivity: type: object additionalProperties: false properties: measured: type: boolean description: Whether measured. complete: type: boolean description: Whether complete. observedBuckets: type: integer minimum: 0 description: |- Specifies observed buckets for this recipient activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedSignals: type: integer minimum: 0 description: |- Specifies dropped signals for this recipient activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | truncated: type: boolean description: Whether truncated. rows: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. recipientCountry: type: string pattern: ^(unknown|[A-Z]{2})$ description: |- Specifies recipient country for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^(unknown\|[A-Z]{2})$` | recipientDeviceCount: type: string enum: - primary_only - one_linked - two_plus_linked - unknown description: |- Number of recipient devices. **Allowed values** | Value | Meaning | | --- | --- | | `primary_only` | Primary only. | | `one_linked` | One linked. | | `two_plus_linked` | Two plus linked. | | `unknown` | Unknown. | deviceSource: type: string enum: - primary - linked - unknown description: |- Specifies device source for this row. **Allowed values** | Value | Meaning | | --- | --- | | `primary` | Primary. | | `linked` | Linked. | | `unknown` | Unknown. | incomingMessages: type: integer minimum: 0 description: |- Specifies incoming messages for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveryReceipts: type: integer minimum: 0 description: |- Specifies delivery receipts for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readReceipts: type: integer minimum: 0 description: |- Specifies read receipts for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | onlineSignals: type: integer minimum: 0 description: |- Specifies online signals for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | offlineSignals: type: integer minimum: 0 description: |- Specifies offline signals for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | typingSignals: type: integer minimum: 0 description: |- Specifies typing signals for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastSignalAt: type: integer description: Unix milliseconds. quietGaps: type: integer minimum: 0 description: |- Specifies quiet gaps for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | quietGapMs: type: integer minimum: 0 description: |- Specifies quiet gap ms for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageQuietGapMs: type: number minimum: 0 nullable: true description: >- Specifies average quiet gap ms for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - ts - recipientCountry - recipientDeviceCount - deviceSource - incomingMessages - deliveryReceipts - readReceipts - onlineSignals - offlineSignals - typingSignals - lastSignalAt - quietGaps - quietGapMs - averageQuietGapMs maxItems: 4096 description: |- Rows associated with this recipient activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `4096` items | required: - measured - complete - observedBuckets - droppedSignals - truncated - rows description: >- Hourly aggregate recipient observations, grouped jointly by numbering country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured. required: - measured - observedHours - lastObservedAt - outgoingMessages - incomingMessages - sendAttempts - sendFailures - sendFailureRate - businessReplies - averageBusinessResponseMs - onlineMs - disconnects - connectFailures - streamErrors - keepaliveTimeouts - engagement - totalNumbers - measuredNumbers - connectedNumbers - messageAnalysis - customerActivity - accountActivity - responseQueue - calls - deviceAnalytics - conversationBreakdown description: >- Structured summary values for this management whats app analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `measured`, `observedHours`, `lastObservedAt`, `outgoingMessages`, `incomingMessages`, `sendAttempts`, `sendFailures`, `sendFailureRate`, `businessReplies`, `averageBusinessResponseMs`, `onlineMs`, `disconnects`, `connectFailures`, `streamErrors`, `keepaliveTimeouts`, `engagement`, `totalNumbers`, `measuredNumbers`, `connectedNumbers`, `messageAnalysis`, `customerActivity`, `accountActivity`, `responseQueue`, `calls`, `deviceAnalytics`, `conversationBreakdown` | | Alternative 2 | `null` | numbers: type: array items: type: object additionalProperties: false properties: sessionId: type: string format: uuid description: |- Identifier of the connected Polymorfa session. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | projectId: type: string format: uuid description: |- Identifier of the Polymorfa project that owns this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | name: type: string description: Human-readable name for this resource. backend: type: string description: Specifies backend for this number. status: type: string description: Current status of this resource or operation. measured: type: boolean description: Whether measured. observedHours: type: integer minimum: 0 description: |- Specifies observed hours for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastObservedAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true outgoingMessages: type: integer minimum: 0 description: |- Specifies outgoing messages for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | incomingMessages: type: integer minimum: 0 description: |- Specifies incoming messages for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendAttempts: type: integer minimum: 0 description: |- Specifies send attempts for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailures: type: integer minimum: 0 description: |- Specifies send failures for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailureRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies send failure rate for this number. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | businessReplies: type: integer minimum: 0 description: |- Specifies business replies for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageBusinessResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average business response ms for this number. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | onlineMs: type: integer minimum: 0 description: |- Specifies online ms for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | disconnects: type: integer minimum: 0 description: |- Specifies disconnects for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | connectFailures: type: integer minimum: 0 description: |- Specifies connect failures for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | streamErrors: type: integer minimum: 0 description: |- Specifies stream errors for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | keepaliveTimeouts: type: integer minimum: 0 description: |- Specifies keepalive timeouts for this number. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | engagement: type: object additionalProperties: false properties: windowHours: type: integer enum: - 24 description: |- Specifies window hours for this engagement. **Allowed values** | Value | Meaning | | --- | --- | | `24` | 24. | completedConversations: type: integer minimum: 0 description: |- Specifies completed conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveredConversations: type: integer minimum: 0 description: |- Specifies delivered conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readConversations: type: integer minimum: 0 description: |- Specifies read conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | repliedConversations: type: integer minimum: 0 description: |- Specifies replied conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveryRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies delivery rate for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | readRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies read rate for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | replyRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies reply rate for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageCustomerReplyMs: type: number minimum: 0 nullable: true description: >- Specifies average customer reply ms for this engagement. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | complete: type: boolean description: Whether complete. droppedConversations: type: integer minimum: 0 description: |- Specifies dropped conversations for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedRecords: type: integer minimum: 0 description: |- Specifies dropped records for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedReceiptJoins: type: integer minimum: 0 description: |- Specifies dropped receipt joins for this engagement. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - windowHours - completedConversations - deliveredConversations - readConversations - repliedConversations - deliveryRate - readRate - replyRate - averageCustomerReplyMs - complete - droppedConversations - droppedRecords - droppedReceiptJoins description: Structured engagement values for this number. messageAnalysis: type: object additionalProperties: false properties: complete: type: boolean description: Whether complete. segments: type: array items: type: object additionalProperties: false properties: dimension: type: string enum: - message_type - text_band - origin - calling_code - customer_devices description: |- Specifies dimension for this segment. **Allowed values** | Value | Meaning | | --- | --- | | `message_type` | Message type. | | `text_band` | Text band. | | `origin` | Origin. | | `calling_code` | Calling code. | | `customer_devices` | Customer devices. | key: type: string description: Specifies key for this segment. sendAttempts: type: integer minimum: 0 description: |- Specifies send attempts for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sent: type: integer minimum: 0 description: |- Specifies sent for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailures: type: integer minimum: 0 description: |- Specifies send failures for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailureRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies send failure rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | completedConversations: type: integer minimum: 0 description: |- Specifies completed conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveredConversations: type: integer minimum: 0 description: |- Specifies delivered conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readConversations: type: integer minimum: 0 description: |- Specifies read conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | repliedConversations: type: integer minimum: 0 description: |- Specifies replied conversations for this segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveryRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies delivery rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | readRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies read rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | replyRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies reply rate for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageCustomerReplyMs: type: number minimum: 0 nullable: true description: >- Specifies average customer reply ms for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shareOfConversations: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share of conversations for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | shareOfSends: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share of sends for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | readRateInterval95: type: array nullable: true minItems: 2 maxItems: 2 items: type: number minimum: 0 maximum: 1 description: >- 95% Wilson interval for observed conversation receipts or replies; not a causal effect. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `array`; Array size: `2` through `2` items; Item numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `2` through `2` items | | Item numeric value | `0` through `1` (inclusive) | replyRateInterval95: type: array nullable: true minItems: 2 maxItems: 2 items: type: number minimum: 0 maximum: 1 description: >- 95% Wilson interval for observed conversation receipts or replies; not a causal effect. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `array`; Array size: `2` through `2` items; Item numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `2` through `2` items | | Item numeric value | `0` through `1` (inclusive) | readRateDifference: type: number minimum: -1 maximum: 1 nullable: true description: >- Specifies read rate difference for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `-1` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `-1` through `1` (inclusive) | replyRateDifference: type: number minimum: -1 maximum: 1 nullable: true description: >- Specifies reply rate difference for this segment. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `-1` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `-1` through `1` (inclusive) | required: - dimension - key - sendAttempts - sent - sendFailures - sendFailureRate - completedConversations - deliveredConversations - readConversations - repliedConversations - deliveryRate - readRate - replyRate - averageCustomerReplyMs - shareOfConversations - shareOfSends - readRateInterval95 - replyRateInterval95 - readRateDifference - replyRateDifference description: Segments associated with this message analysi. required: - complete - segments description: Structured message analysis values for this number. customerActivity: type: object additionalProperties: false properties: observed: type: boolean description: Whether observed. onlineSignals: type: integer minimum: 0 description: |- Specifies online signals for this customer activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | offlineSignals: type: integer minimum: 0 description: |- Specifies offline signals for this customer activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | typingSignals: type: integer minimum: 0 description: |- Specifies typing signals for this customer activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - observed - onlineSignals - offlineSignals - typingSignals description: Structured customer activity values for this number. accountActivity: type: object additionalProperties: false properties: observed: type: boolean description: Whether observed. primaryPhoneActivitySignals: type: integer minimum: 0 description: >- Specifies primary phone activity signals for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | primaryPhoneActivePeriods: type: integer minimum: 0 description: >- Specifies primary phone active periods for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | completedPhoneActivityPeriods: type: integer minimum: 0 description: >- Specifies completed phone activity periods for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneActivityMs: type: integer minimum: 0 description: |- Specifies phone activity ms for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePhoneActivityMs: type: number minimum: 0 nullable: true description: >- Specifies average phone activity ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneQuietGaps: type: integer minimum: 0 description: |- Specifies phone quiet gaps for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneQuietMs: type: integer minimum: 0 description: |- Specifies phone quiet ms for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePhoneQuietMs: type: number minimum: 0 nullable: true description: >- Specifies average phone quiet ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | primaryPhoneMessages: type: integer minimum: 0 description: >- Specifies primary phone messages for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | otherDeviceMessages: type: integer minimum: 0 description: |- Specifies other device messages for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastPrimaryPhoneAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true primaryPhoneReplies: type: integer minimum: 0 description: |- Specifies primary phone replies for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | otherDeviceReplies: type: integer minimum: 0 description: |- Specifies other device replies for this account activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePrimaryPhoneResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average primary phone response ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageOtherDeviceResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average other device response ms for this account activity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - observed - primaryPhoneActivitySignals - primaryPhoneActivePeriods - completedPhoneActivityPeriods - phoneActivityMs - averagePhoneActivityMs - phoneQuietGaps - phoneQuietMs - averagePhoneQuietMs - primaryPhoneMessages - otherDeviceMessages - lastPrimaryPhoneAt - primaryPhoneReplies - otherDeviceReplies - averagePrimaryPhoneResponseMs - averageOtherDeviceResponseMs description: Structured account activity values for this number. responseQueue: type: object nullable: true allOf: - type: object additionalProperties: false properties: awaitingReply: type: integer minimum: 0 description: |- Specifies awaiting reply for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | oldestWaitingMs: type: integer minimum: 0 description: |- Specifies oldest waiting ms for this all of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | observedAt: type: integer description: Unix milliseconds. complete: type: boolean description: Whether complete. required: - awaitingReply - oldestWaitingMs - observedAt - complete description: >- Structured response queue values for this number. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `awaitingReply`, `oldestWaitingMs`, `observedAt`, `complete` | | Alternative 2 | `null` | projectName: type: string description: Human-readable project name for this number. calls: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this call. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | directions: type: object additionalProperties: false properties: inbound: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this inbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this inbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video description: Structured inbound values for this direction. outbound: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this outbound. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this outbound. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video description: Structured outbound values for this direction. required: - inbound - outbound description: Structured directions values for this call. mediaQuality: type: object additionalProperties: false properties: measuredCalls: type: integer minimum: 0 description: |- Specifies measured calls for this media quality. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageJitterMs: type: number minimum: 0 nullable: true description: >- Specifies average jitter ms for this media quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageRttMs: type: number minimum: 0 nullable: true description: >- Specifies average rtt ms for this media quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | packetsLost: type: integer minimum: 0 nullable: true description: >- Specifies packets lost for this media quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - measuredCalls - averageJitterMs - averageRttMs - packetsLost description: Structured media quality values for this call. appQuality: type: object additionalProperties: false properties: measuredCalls: type: integer minimum: 0 description: |- Specifies measured calls for this app quality. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageJitterMs: type: number minimum: 0 nullable: true description: >- Specifies average jitter ms for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageRttMs: type: number minimum: 0 nullable: true description: >- Specifies average rtt ms for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | packetLossRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies packet loss rate for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | reconnects: type: integer minimum: 0 nullable: true description: >- Specifies reconnects for this app quality. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - measuredCalls - averageJitterMs - averageRttMs - packetLossRate - reconnects description: Structured app quality values for this call. endReasons: type: array items: type: object additionalProperties: false properties: code: type: string description: Stable machine-readable code for this result. count: type: integer minimum: 0 description: |- Number of matching resources. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - code - count description: End reasons associated with this call. appErrors: type: array items: type: object additionalProperties: false properties: code: type: string description: Stable machine-readable code for this result. count: type: integer minimum: 0 description: |- Number of matching resources. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - code - count description: App errors associated with this call. transports: type: array items: type: object additionalProperties: false properties: code: type: string description: Stable machine-readable code for this result. count: type: integer minimum: 0 description: |- Number of matching resources. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - code - count description: Transports associated with this call. multiParticipantCalls: type: integer minimum: 0 description: |- Specifies multi participant calls for this call. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | followUp: type: object additionalProperties: false properties: eligibleMissed: type: integer minimum: 0 description: |- Specifies eligible missed for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | returnedWithin24h: type: integer minimum: 0 description: |- Specifies returned within24h for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | rate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies rate for this follow up. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageDelayMs: type: number minimum: 0 nullable: true description: >- Specifies average delay ms for this follow up. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | pendingWindow: type: integer minimum: 0 description: |- Specifies pending window for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | unknownContact: type: integer minimum: 0 description: |- Specifies unknown contact for this follow up. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - eligibleMissed - returnedWithin24h - rate - averageDelayMs - pendingWindow - unknownContact description: Structured follow up values for this call. required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video - directions - mediaQuality - appQuality - endReasons - appErrors - transports - multiParticipantCalls - followUp description: Structured calls values for this number. deviceAnalytics: type: object additionalProperties: false properties: detector: type: string enum: - message_id_prefix/v1 description: |- Specifies detector for this device analytic. **Allowed values** | Value | Meaning | | --- | --- | | `message_id_prefix/v1` | Message id prefix/v1. | measured: type: boolean description: >- True when at least one retained bucket has client-family measurement coverage, including buckets with zero messages. complete: type: boolean description: >- True when measured is true, every retained bucket has device-family coverage and conversation receipt coverage is complete. False when coverage is missing or records, conversations or receipt joins were dropped. Inventory truncation is reported separately. observedBuckets: type: integer minimum: 0 description: |- Specifies observed buckets for this device analytic. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | customerMessages: type: integer minimum: 0 nullable: true description: >- Specifies customer messages for this device analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | accountMessages: type: integer minimum: 0 nullable: true description: >- Specifies account messages for this device analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | customerPlatforms: type: array items: type: object additionalProperties: false properties: platform: type: string enum: - web - android - iphone - ipad - macos - windows - wearable - ar_device - unknown description: >- Sending client family estimated from a message ID prefix; not verified hardware or operating system. **Allowed values** | Value | Meaning | | --- | --- | | `web` | Web client. | | `android` | Android client. | | `iphone` | iPhone client. | | `ipad` | iPad client. | | `macos` | macOS client. | | `windows` | Windows client. | | `wearable` | Wearable client. | | `ar_device` | AR device client. | | `unknown` | No recognized client-family prefix. | messages: type: integer minimum: 0 description: |- Specifies messages for this customer platform. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | share: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share for this customer platform. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | required: - platform - messages - share description: Customer platforms associated with this device analytic. accountPlatforms: type: array items: type: object additionalProperties: false properties: platform: type: string enum: - web - android - iphone - ipad - macos - windows - wearable - ar_device - unknown description: >- Sending client family estimated from a message ID prefix; not verified hardware or operating system. **Allowed values** | Value | Meaning | | --- | --- | | `web` | Web client. | | `android` | Android client. | | `iphone` | iPhone client. | | `ipad` | iPad client. | | `macos` | macOS client. | | `windows` | Windows client. | | `wearable` | Wearable client. | | `ar_device` | AR device client. | | `unknown` | No recognized client-family prefix. | messages: type: integer minimum: 0 description: |- Specifies messages for this account platform. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | share: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies share for this account platform. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | required: - platform - messages - share description: Account platforms associated with this device analytic. inventory: type: object additionalProperties: false properties: listObserved: type: boolean description: >- True after a full device list for this number was observed. listCurrent: type: boolean description: >- True when a full list was observed and no later list-change signal invalidated it. Membership and device count are unknown until another full list after a change. observedAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true deviceCount: type: integer minimum: 0 nullable: true description: >- Number of devices. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | truncated: type: boolean description: >- True when the bounded inventory omitted devices. At most 25 device rows are returned; a current full-list device count can be larger. devices: type: array items: type: object additionalProperties: false properties: deviceIndex: type: integer minimum: 0 maximum: 999 description: >- Specifies device index for this device. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `999` (inclusive) | estimatedPlatform: type: string enum: - web - android - iphone - ipad - macos - windows - wearable - ar_device - unknown description: >- Sending client family estimated from a message ID prefix; not verified hardware or operating system. **Allowed values** | Value | Meaning | | --- | --- | | `web` | Web client. | | `android` | Android client. | | `iphone` | iPhone client. | | `ipad` | iPad client. | | `macos` | macOS client. | | `windows` | Windows client. | | `wearable` | Wearable client. | | `ar_device` | AR device client. | | `unknown` | No recognized client-family prefix. | reportedClass: type: string enum: - phone - desktop_app - browser - business_api - unknown description: >- Specifies reported class for this device. **Allowed values** | Value | Meaning | | --- | --- | | `phone` | Phone. | | `desktop_app` | Desktop app. | | `browser` | Browser. | | `business_api` | Business API. | | `unknown` | No recognized reported device class. | lastActiveAt: type: integer description: |- Unix milliseconds. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | nullable: true listed: type: boolean nullable: true description: >- Whether this device index belongs to the latest observed full list. Null when that list is no longer current. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `boolean` | | Alternative 2 | `null` | required: - deviceIndex - estimatedPlatform - reportedClass - lastActiveAt - listed maxItems: 25 description: |- Devices associated with this inventory. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `25` items | required: - listObserved - listCurrent - observedAt - deviceCount - truncated - devices nullable: true description: >- Structured inventory values for this device analytic. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `listObserved`, `listCurrent`, `observedAt`, `deviceCount`, `truncated`, `devices` | | Alternative 2 | `null` | required: - detector - measured - complete - observedBuckets - customerMessages - accountMessages - customerPlatforms - accountPlatforms - inventory description: >- Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory. conversationBreakdown: type: object additionalProperties: false properties: measured: type: boolean description: >- True when at least one retained bucket includes joint conversation categories. complete: type: boolean description: >- True when measured is true, every retained bucket has joint conversation coverage, no conversation, record or receipt-join coverage was lost and the returned groups are not truncated. Rates and averages are null when false. observedBuckets: type: integer minimum: 0 description: >- Specifies observed buckets for this conversation breakdown. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedConversations: type: integer minimum: 0 description: >- Specifies dropped conversations for this conversation breakdown. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | truncated: type: boolean description: >- True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null. buckets: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. complete: type: boolean description: >- True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket. required: - ts - complete description: Buckets associated with this conversation breakdown. rows: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. messageType: type: string enum: - text - image - video - audio - document - sticker - interactive - template - other description: |- Category assigned to message. **Allowed values** | Value | Meaning | | --- | --- | | `text` | Text. | | `image` | Image. | | `video` | Video. | | `audio` | Audio. | | `document` | Document. | | `sticker` | Sticker. | | `interactive` | Interactive. | | `template` | Template. | | `other` | Other. | textBand: type: string enum: - none - short - medium - long - very_long - unknown description: |- Specifies text band for this row. **Allowed values** | Value | Meaning | | --- | --- | | `none` | None. | | `short` | Short. | | `medium` | Medium. | | `long` | Long. | | `very_long` | Very long. | | `unknown` | Unknown. | origin: type: string enum: - api - campaign - other description: |- Specifies origin for this row. **Allowed values** | Value | Meaning | | --- | --- | | `api` | API send. | | `campaign` | Campaign send. | | `other` | Other or unclassified send source. | recipientCountry: type: string pattern: ^(unknown|[A-Z]{2})$ description: >- Numbering country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^(unknown\|[A-Z]{2})$` | recipientDeviceCount: type: string enum: - primary_only - one_linked - two_plus_linked - unknown description: >- Observed linked-device range; device zero is the primary and is excluded from linked counts. **Allowed values** | Value | Meaning | | --- | --- | | `primary_only` | Primary only. | | `one_linked` | One linked. | | `two_plus_linked` | Two plus linked. | | `unknown` | Unknown. | callingCode: type: string pattern: ^(unknown|[1-9][0-9]{0,2})$ description: |- Machine-readable calling code for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^(unknown\|[1-9][0-9]{0,2})$` | customerDevices: type: string enum: - single - multiple - unknown description: |- Specifies customer devices for this row. **Allowed values** | Value | Meaning | | --- | --- | | `single` | Single. | | `multiple` | Multiple. | | `unknown` | Unknown. | completedConversations: type: integer minimum: 0 description: |- Specifies completed conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveredConversations: type: integer minimum: 0 description: |- Specifies delivered conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readConversations: type: integer minimum: 0 description: |- Specifies read conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | repliedConversations: type: integer minimum: 0 description: |- Specifies replied conversations for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | replyLatencySumMs: type: integer minimum: 0 description: |- Specifies reply latency sum ms for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies read rate for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | replyRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies reply rate for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | averageCustomerReplyMs: type: number minimum: 0 nullable: true description: >- Specifies average customer reply ms for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - ts - messageType - textBand - origin - recipientCountry - recipientDeviceCount - callingCode - customerDevices - completedConversations - deliveredConversations - readConversations - repliedConversations - replyLatencySumMs - readRate - replyRate - averageCustomerReplyMs maxItems: 4096 description: |- Rows associated with this conversation breakdown. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `4096` items | required: - measured - complete - observedBuckets - droppedConversations - truncated - buckets - rows description: >- Completed 24-hour conversation cohorts grouped jointly by completion bucket, first outgoing message metadata, calling code and observed device-count class. recipientActivity: type: object additionalProperties: false properties: measured: type: boolean description: Whether measured. complete: type: boolean description: Whether complete. observedBuckets: type: integer minimum: 0 description: |- Specifies observed buckets for this recipient activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | droppedSignals: type: integer minimum: 0 description: |- Specifies dropped signals for this recipient activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | truncated: type: boolean description: Whether truncated. rows: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. recipientCountry: type: string pattern: ^(unknown|[A-Z]{2})$ description: |- Specifies recipient country for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^(unknown\|[A-Z]{2})$` | recipientDeviceCount: type: string enum: - primary_only - one_linked - two_plus_linked - unknown description: |- Number of recipient devices. **Allowed values** | Value | Meaning | | --- | --- | | `primary_only` | Primary only. | | `one_linked` | One linked. | | `two_plus_linked` | Two plus linked. | | `unknown` | Unknown. | deviceSource: type: string enum: - primary - linked - unknown description: |- Specifies device source for this row. **Allowed values** | Value | Meaning | | --- | --- | | `primary` | Primary. | | `linked` | Linked. | | `unknown` | Unknown. | incomingMessages: type: integer minimum: 0 description: |- Specifies incoming messages for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | deliveryReceipts: type: integer minimum: 0 description: |- Specifies delivery receipts for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | readReceipts: type: integer minimum: 0 description: |- Specifies read receipts for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | onlineSignals: type: integer minimum: 0 description: |- Specifies online signals for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | offlineSignals: type: integer minimum: 0 description: |- Specifies offline signals for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | typingSignals: type: integer minimum: 0 description: |- Specifies typing signals for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastSignalAt: type: integer description: Unix milliseconds. quietGaps: type: integer minimum: 0 description: |- Specifies quiet gaps for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | quietGapMs: type: integer minimum: 0 description: |- Specifies quiet gap ms for this row. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageQuietGapMs: type: number minimum: 0 nullable: true description: >- Specifies average quiet gap ms for this row. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - ts - recipientCountry - recipientDeviceCount - deviceSource - incomingMessages - deliveryReceipts - readReceipts - onlineSignals - offlineSignals - typingSignals - lastSignalAt - quietGaps - quietGapMs - averageQuietGapMs maxItems: 4096 description: |- Rows associated with this recipient activity. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `4096` items | required: - measured - complete - observedBuckets - droppedSignals - truncated - rows description: >- Hourly aggregate recipient observations, grouped jointly by numbering country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured. required: - sessionId - projectId - name - backend - status - measured - observedHours - lastObservedAt - outgoingMessages - incomingMessages - sendAttempts - sendFailures - sendFailureRate - businessReplies - averageBusinessResponseMs - onlineMs - disconnects - connectFailures - streamErrors - keepaliveTimeouts - engagement - messageAnalysis - customerActivity - accountActivity - responseQueue - projectName - calls - deviceAnalytics - conversationBreakdown description: Numbers associated with this management whats app analytic. series: type: array items: type: object additionalProperties: false properties: ts: type: integer description: Unix milliseconds. outgoingMessages: type: integer minimum: 0 description: |- Specifies outgoing messages for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | incomingMessages: type: integer minimum: 0 description: |- Specifies incoming messages for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sendFailures: type: integer minimum: 0 description: |- Specifies send failures for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | businessReplies: type: integer minimum: 0 description: |- Specifies business replies for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageBusinessResponseMs: type: number minimum: 0 nullable: true description: >- Specifies average business response ms for this sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | onlineMs: type: integer minimum: 0 description: |- Specifies online ms for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | disconnects: type: integer minimum: 0 description: |- Specifies disconnects for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sessionId: type: string format: uuid description: |- Identifier of the connected Polymorfa session. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | customerOnlineSignals: type: integer minimum: 0 description: |- Specifies customer online signals for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | customerTypingSignals: type: integer minimum: 0 description: |- Specifies customer typing signals for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | primaryPhoneMessages: type: integer minimum: 0 description: |- Specifies primary phone messages for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | otherDeviceMessages: type: integer minimum: 0 description: |- Specifies other device messages for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | primaryPhoneReplies: type: integer minimum: 0 description: |- Specifies primary phone replies for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneActivePeriods: type: integer minimum: 0 description: |- Specifies phone active periods for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | completedPhoneActivityPeriods: type: integer minimum: 0 description: |- Specifies completed phone activity periods for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneActivityMs: type: integer minimum: 0 description: |- Specifies phone activity ms for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneQuietGaps: type: integer minimum: 0 description: |- Specifies phone quiet gaps for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | phoneQuietMs: type: integer minimum: 0 description: |- Specifies phone quiet ms for this sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - ts - outgoingMessages - incomingMessages - sendFailures - businessReplies - averageBusinessResponseMs - onlineMs - disconnects - sessionId - customerOnlineSignals - customerTypingSignals - primaryPhoneMessages - otherDeviceMessages - primaryPhoneReplies - phoneActivePeriods - completedPhoneActivityPeriods - phoneActivityMs - phoneQuietGaps - phoneQuietMs description: Series associated with this management whats app analytic. callSeries: type: array items: type: object additionalProperties: false properties: total: type: integer minimum: 0 description: |- Final total for this order or price summary. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answered: type: integer minimum: 0 description: |- Specifies answered for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | missed: type: integer minimum: 0 description: |- Specifies missed for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | declined: type: integer minimum: 0 description: |- Specifies declined for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | failed: type: integer minimum: 0 description: |- Specifies failed for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | ringing: type: integer minimum: 0 description: |- Specifies ringing for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | answerRate: type: number minimum: 0 maximum: 1 nullable: true description: >- Specifies answer rate for this call sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` through `1` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `1` (inclusive) | talkSeconds: type: integer minimum: 0 description: |- Specifies talk seconds for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedAnswered: type: integer minimum: 0 description: |- Specifies timed answered for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | timedPickup: type: integer minimum: 0 description: |- Specifies timed pickup for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averageTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies average talk seconds for this call sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | medianTalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies median talk seconds for this call sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95TalkSeconds: type: number minimum: 0 nullable: true description: >- Specifies p95 talk seconds for this call sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | averagePickupMs: type: number minimum: 0 nullable: true description: >- Specifies average pickup ms for this call sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | p95PickupMs: type: number minimum: 0 nullable: true description: >- Specifies p95 pickup ms for this call sery. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: `0` or greater | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | shortAnswered: type: integer minimum: 0 description: |- Specifies short answered for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | video: type: integer minimum: 0 description: |- Specifies video for this call sery. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | sessionId: type: string format: uuid description: |- Identifier of the connected Polymorfa session. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | ts: type: integer description: Unix milliseconds. required: - total - answered - missed - declined - failed - ringing - answerRate - talkSeconds - timedAnswered - timedPickup - averageTalkSeconds - medianTalkSeconds - p95TalkSeconds - averagePickupMs - p95PickupMs - shortAnswered - video - sessionId - ts description: Call series associated with this management whats app analytic. required: - enabled - period - requestVitals - summary - numbers - series - callSeries management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param - request_id properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | request_id: type: string description: >- Matches the X-Request-Id response header. Include it when you contact support. request_log_url: type: string format: uri description: >- Console page that shows this request. Returned only to organization and project credentials whose request was logged. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | responses: management__BadRequest: description: A path, query, or request-body value did not pass validation. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__NotFound: description: >- The requested resource was not found inside the authenticated team or project scope. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__PropagationPending: description: >- The change was stored, but a connected number has not confirmed it. Retry the request; the stored setting is already correct and is retried automatically. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Send your team API key or project token as `Authorization: Bearer `. The credential must have the required permissions. Project tokens can access only their own project. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.