Skip to content
Shortcut: /, ⌘K or Ctrl+K

Analytics

View as Markdown

The WhatsApp analytics object

Attributes

  • enabledbooleanrequired

    Whether this feature is enabled.

  • periodobjectrequired

    Structured period values for this management whats app analytic.

    Show 2 child fields
  • requestVitalsobjectrequired

    Structured request vitals values for this management whats app analytic.

    Show 3 child fields
  • summaryobjectrequirednullable

    Structured summary values for this management whats app analytic.

    Show 27 child fields
  • numbersarray of objectrequired

    Numbers associated with this management whats app analytic.

    Show 30 child fields
  • seriesarray of objectrequired

    Series associated with this management whats app analytic.

    Show 19 child fields
  • callSeriesarray of objectrequired

    Call series associated with this management whats app analytic.

    Show 19 child fields
The WhatsApp analytics object
{
  "enabled": true,
  "period": {
    "start": 0,
    "end": 0
  },
  "requestVitals": {
    "requests": 0,
    "failures": 0,
    "errorRate": 0
  },
  "summary": {
    "measured": true,
    "observedHours": 0,
    "lastObservedAt": 0,
    "outgoingMessages": 0,
    "incomingMessages": 0,
    "sendAttempts": 0,
    "sendFailures": 0,
    "sendFailureRate": 0,
    "businessReplies": 0,
    "averageBusinessResponseMs": 0,
    "onlineMs": 0,
    "disconnects": 0,
    "connectFailures": 0,
    "streamErrors": 0,
    "keepaliveTimeouts": 0,
    "engagement": {
      "windowHours": 24,
      "completedConversations": 0,
      "deliveredConversations": 0,
      "readConversations": 0,
      "repliedConversations": 0,
      "deliveryRate": 0,
      "readRate": 0,
      "replyRate": 0,
      "averageCustomerReplyMs": 0,
      "complete": true,
      "droppedConversations": 0,
      "droppedRecords": 0,
      "droppedReceiptJoins": 0
    },
    "totalNumbers": 0,
    "measuredNumbers": 0,
    "connectedNumbers": 0,
    "messageAnalysis": {
      "complete": true,
      "segments": [
        {
          "dimension": "message_type",
          "key": "string",
          "sendAttempts": 0,
          "sent": 0,
          "sendFailures": 0,
          "sendFailureRate": 0,
          "completedConversations": 0,
          "deliveredConversations": 0,
          "readConversations": 0,
          "repliedConversations": 0,
          "deliveryRate": 0,
          "readRate": 0,
          "replyRate": 0,
          "averageCustomerReplyMs": 0,
          "shareOfConversations": 0,
          "shareOfSends": 0,
          "readRateInterval95": [
            0
          ],
          "replyRateInterval95": [
            0
          ],
          "readRateDifference": -1,
          "replyRateDifference": -1
        }
      ]
    },
    "customerActivity": {
      "observed": true,
      "onlineSignals": 0,
      "offlineSignals": 0,
      "typingSignals": 0
    },
    "accountActivity": {
      "observed": true,
      "primaryPhoneActivitySignals": 0,
      "primaryPhoneActivePeriods": 0,
      "completedPhoneActivityPeriods": 0,
      "phoneActivityMs": 0,
      "averagePhoneActivityMs": 0,
      "phoneQuietGaps": 0,
      "phoneQuietMs": 0,
      "averagePhoneQuietMs": 0,
      "primaryPhoneMessages": 0,
      "otherDeviceMessages": 0,
      "lastPrimaryPhoneAt": 0,
      "primaryPhoneReplies": 0,
      "otherDeviceReplies": 0,
      "averagePrimaryPhoneResponseMs": 0,
      "averageOtherDeviceResponseMs": 0
    },
    "responseQueue": {
      "awaitingReply": 0,
      "oldestWaitingMs": 0,
      "observedAt": 0,
      "complete": true
    },
    "calls": {
      "total": 0,
      "answered": 0,
      "missed": 0,
      "declined": 0,
      "failed": 0,
      "ringing": 0,
      "answerRate": 0,
      "talkSeconds": 0,
      "timedAnswered": 0,
      "timedPickup": 0,
      "averageTalkSeconds": 0,
      "medianTalkSeconds": 0,
      "p95TalkSeconds": 0,
      "averagePickupMs": 0,
      "p95PickupMs": 0,
      "shortAnswered": 0,
      "video": 0,
      "directions": {
        "inbound": {
          "total": 0,
          "answered": 0,
          "missed": 0,
          "declined": 0,
          "failed": 0,
          "ringing": 0,
          "answerRate": 0,
          "talkSeconds": 0,
          "timedAnswered": 0,
          "timedPickup": 0,
          "averageTalkSeconds": 0,
          "medianTalkSeconds": 0,
          "p95TalkSeconds": 0,
          "averagePickupMs": 0,
          "p95PickupMs": 0,
          "shortAnswered": 0,
          "video": 0
        },
        "outbound": {
          "total": 0,
          "answered": 0,
          "missed": 0,
          "declined": 0,
          "failed": 0,
          "ringing": 0,
          "answerRate": 0,
          "talkSeconds": 0,
          "timedAnswered": 0,
          "timedPickup": 0,
          "averageTalkSeconds": 0,
          "medianTalkSeconds": 0,
          "p95TalkSeconds": 0,
          "averagePickupMs": 0,
          "p95PickupMs": 0,
          "shortAnswered": 0,
          "video": 0
        }
      },
      "mediaQuality": {
        "measuredCalls": 0,
        "averageJitterMs": 0,
        "averageRttMs": 0,
        "packetsLost": 0
      },
      "appQuality": {
        "measuredCalls": 0,
        "averageJitterMs": 0,
        "averageRttMs": 0,
        "packetLossRate": 0,
        "reconnects": 0
      },
      "endReasons": [
        {
          "code": "string",
          "count": 0
        }
      ],
      "appErrors": [
        {
          "code": "string",
          "count": 0
        }
      ],
      "transports": [
        {
          "code": "string",
          "count": 0
        }
      ],
      "multiParticipantCalls": 0,
      "followUp": {
        "eligibleMissed": 0,
        "returnedWithin24h": 0,
        "rate": 0,
        "averageDelayMs": 0,
        "pendingWindow": 0,
        "unknownContact": 0
      }
    },
    "deviceAnalytics": {
      "detector": "message_id_prefix/v1",
      "measured": true,
      "complete": true,
      "observedBuckets": 0,
      "customerMessages": 0,
      "accountMessages": 0,
      "customerPlatforms": [
        {
          "platform": "web",
          "messages": 0,
          "share": 0
        }
      ],
      "accountPlatforms": [
        {
          "platform": "web",
          "messages": 0,
          "share": 0
        }
      ],
      "inventory": {
        "listObserved": true,
        "listCurrent": true,
        "observedAt": 0,
        "deviceCount": 0,
        "truncated": true,
        "devices": [
          {
            "deviceIndex": 0,
            "estimatedPlatform": "web",
            "reportedClass": "phone",
            "lastActiveAt": 0,
            "listed": true
          }
        ]
      }
    },
    "conversationBreakdown": {
      "measured": true,
      "complete": true,
      "observedBuckets": 0,
      "droppedConversations": 0,
      "truncated": true,
      "buckets": [
        {
          "ts": 0,
          "complete": true
        }
      ],
      "rows": [
        {
          "ts": 0,
          "messageType": "text",
          "textBand": "none",
          "origin": "api",
          "recipientCountry": "string",
          "recipientDeviceCount": "primary_only",
          "callingCode": "string",
          "customerDevices": "single",
          "completedConversations": 0,
          "deliveredConversations": 0,
          "readConversations": 0,
          "repliedConversations": 0,
          "replyLatencySumMs": 0,
          "readRate": 0,
          "replyRate": 0,
          "averageCustomerReplyMs": 0
        }
      ]
    },
    "recipientActivity": {
      "measured": true,
      "complete": true,
      "observedBuckets": 0,
      "droppedSignals": 0,
      "truncated": true,
      "rows": [
        {
          "ts": 0,
          "recipientCountry": "string",
          "recipientDeviceCount": "primary_only",
          "deviceSource": "primary",
          "incomingMessages": 0,
          "deliveryReceipts": 0,
          "readReceipts": 0,
          "onlineSignals": 0,
          "offlineSignals": 0,
          "typingSignals": 0,
          "lastSignalAt": 0,
          "quietGaps": 0,
          "quietGapMs": 0,
          "averageQuietGapMs": 0
        }
      ]
    }
  },
  "numbers": [
    {
      "sessionId": "00000000-0000-4000-8000-000000000000",
      "projectId": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "backend": "string",
      "status": "string",
      "measured": true,
      "observedHours": 0,
      "lastObservedAt": 0,
      "outgoingMessages": 0,
      "incomingMessages": 0,
      "sendAttempts": 0,
      "sendFailures": 0,
      "sendFailureRate": 0,
      "businessReplies": 0,
      "averageBusinessResponseMs": 0,
      "onlineMs": 0,
      "disconnects": 0,
      "connectFailures": 0,
      "streamErrors": 0,
      "keepaliveTimeouts": 0,
      "engagement": {
        "windowHours": 24,
        "completedConversations": 0,
        "deliveredConversations": 0,
        "readConversations": 0,
        "repliedConversations": 0,
        "deliveryRate": 0,
        "readRate": 0,
        "replyRate": 0,
        "averageCustomerReplyMs": 0,
        "complete": true,
        "droppedConversations": 0,
        "droppedRecords": 0,
        "droppedReceiptJoins": 0
      },
      "messageAnalysis": {
        "complete": true,
        "segments": [
          {
            "dimension": "message_type",
            "key": "string",
            "sendAttempts": 0,
            "sent": 0,
            "sendFailures": 0,
            "sendFailureRate": 0,
            "completedConversations": 0,
            "deliveredConversations": 0,
            "readConversations": 0,
            "repliedConversations": 0,
            "deliveryRate": 0,
            "readRate": 0,
            "replyRate": 0,
            "averageCustomerReplyMs": 0,
            "shareOfConversations": 0,
            "shareOfSends": 0,
            "readRateInterval95": [
              null
            ],
            "replyRateInterval95": [
              null
            ],
            "readRateDifference": -1,
            "replyRateDifference": -1
          }
        ]
      },
      "customerActivity": {
        "observed": true,
        "onlineSignals": 0,
        "offlineSignals": 0,
        "typingSignals": 0
      },
      "accountActivity": {
        "observed": true,
        "primaryPhoneActivitySignals": 0,
        "primaryPhoneActivePeriods": 0,
        "completedPhoneActivityPeriods": 0,
        "phoneActivityMs": 0,
        "averagePhoneActivityMs": 0,
        "phoneQuietGaps": 0,
        "phoneQuietMs": 0,
        "averagePhoneQuietMs": 0,
        "primaryPhoneMessages": 0,
        "otherDeviceMessages": 0,
        "lastPrimaryPhoneAt": 0,
        "primaryPhoneReplies": 0,
        "otherDeviceReplies": 0,
        "averagePrimaryPhoneResponseMs": 0,
        "averageOtherDeviceResponseMs": 0
      },
      "responseQueue": {
        "awaitingReply": 0,
        "oldestWaitingMs": 0,
        "observedAt": 0,
        "complete": true
      },
      "projectName": "string",
      "calls": {
        "total": 0,
        "answered": 0,
        "missed": 0,
        "declined": 0,
        "failed": 0,
        "ringing": 0,
        "answerRate": 0,
        "talkSeconds": 0,
        "timedAnswered": 0,
        "timedPickup": 0,
        "averageTalkSeconds": 0,
        "medianTalkSeconds": 0,
        "p95TalkSeconds": 0,
        "averagePickupMs": 0,
        "p95PickupMs": 0,
        "shortAnswered": 0,
        "video": 0,
        "directions": {
          "inbound": {
            "total": 0,
            "answered": 0,
            "missed": 0,
            "declined": 0,
            "failed": 0,
            "ringing": 0,
            "answerRate": 0,
            "talkSeconds": 0,
            "timedAnswered": 0,
            "timedPickup": 0,
            "averageTalkSeconds": 0,
            "medianTalkSeconds": 0,
            "p95TalkSeconds": 0,
            "averagePickupMs": 0,
            "p95PickupMs": 0,
            "shortAnswered": 0,
            "video": 0
          },
          "outbound": {
            "total": 0,
            "answered": 0,
            "missed": 0,
            "declined": 0,
            "failed": 0,
            "ringing": 0,
            "answerRate": 0,
            "talkSeconds": 0,
            "timedAnswered": 0,
            "timedPickup": 0,
            "averageTalkSeconds": 0,
            "medianTalkSeconds": 0,
            "p95TalkSeconds": 0,
            "averagePickupMs": 0,
            "p95PickupMs": 0,
            "shortAnswered": 0,
            "video": 0
          }
        },
        "mediaQuality": {
          "measuredCalls": 0,
          "averageJitterMs": 0,
          "averageRttMs": 0,
          "packetsLost": 0
        },
        "appQuality": {
          "measuredCalls": 0,
          "averageJitterMs": 0,
          "averageRttMs": 0,
          "packetLossRate": 0,
          "reconnects": 0
        },
        "endReasons": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "appErrors": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "transports": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "multiParticipantCalls": 0,
        "followUp": {
          "eligibleMissed": 0,
          "returnedWithin24h": 0,
          "rate": 0,
          "averageDelayMs": 0,
          "pendingWindow": 0,
          "unknownContact": 0
        }
      },
      "deviceAnalytics": {
        "detector": "message_id_prefix/v1",
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "customerMessages": 0,
        "accountMessages": 0,
        "customerPlatforms": [
          {
            "platform": "web",
            "messages": 0,
            "share": 0
          }
        ],
        "accountPlatforms": [
          {
            "platform": "web",
            "messages": 0,
            "share": 0
          }
        ],
        "inventory": {
          "listObserved": true,
          "listCurrent": true,
          "observedAt": 0,
          "deviceCount": 0,
          "truncated": true,
          "devices": [
            {
              "deviceIndex": null,
              "estimatedPlatform": "web",
              "reportedClass": "phone",
              "lastActiveAt": null,
              "listed": null
            }
          ]
        }
      },
      "conversationBreakdown": {
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "droppedConversations": 0,
        "truncated": true,
        "buckets": [
          {
            "ts": 0,
            "complete": true
          }
        ],
        "rows": [
          {
            "ts": 0,
            "messageType": "text",
            "textBand": "none",
            "origin": "api",
            "recipientCountry": "string",
            "recipientDeviceCount": "primary_only",
            "callingCode": "string",
            "customerDevices": "single",
            "completedConversations": 0,
            "deliveredConversations": 0,
            "readConversations": 0,
            "repliedConversations": 0,
            "replyLatencySumMs": 0,
            "readRate": 0,
            "replyRate": 0,
            "averageCustomerReplyMs": 0
          }
        ]
      },
      "recipientActivity": {
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "droppedSignals": 0,
        "truncated": true,
        "rows": [
          {
            "ts": 0,
            "recipientCountry": "string",
            "recipientDeviceCount": "primary_only",
            "deviceSource": "primary",
            "incomingMessages": 0,
            "deliveryReceipts": 0,
            "readReceipts": 0,
            "onlineSignals": 0,
            "offlineSignals": 0,
            "typingSignals": 0,
            "lastSignalAt": 0,
            "quietGaps": 0,
            "quietGapMs": 0,
            "averageQuietGapMs": 0
          }
        ]
      }
    }
  ],
  "series": [
    {
      "ts": 0,
      "outgoingMessages": 0,
      "incomingMessages": 0,
      "sendFailures": 0,
      "businessReplies": 0,
      "averageBusinessResponseMs": 0,
      "onlineMs": 0,
      "disconnects": 0,
      "sessionId": "00000000-0000-4000-8000-000000000000",
      "customerOnlineSignals": 0,
      "customerTypingSignals": 0,
      "primaryPhoneMessages": 0,
      "otherDeviceMessages": 0,
      "primaryPhoneReplies": 0,
      "phoneActivePeriods": 0,
      "completedPhoneActivityPeriods": 0,
      "phoneActivityMs": 0,
      "phoneQuietGaps": 0,
      "phoneQuietMs": 0
    }
  ],
  "callSeries": [
    {
      "total": 0,
      "answered": 0,
      "missed": 0,
      "declined": 0,
      "failed": 0,
      "ringing": 0,
      "answerRate": 0,
      "talkSeconds": 0,
      "timedAnswered": 0,
      "timedPickup": 0,
      "averageTalkSeconds": 0,
      "medianTalkSeconds": 0,
      "p95TalkSeconds": 0,
      "averagePickupMs": 0,
      "p95PickupMs": 0,
      "shortAnswered": 0,
      "video": 0,
      "sessionId": "00000000-0000-4000-8000-000000000000",
      "ts": 0
    }
  ]
}

Export team analytics metrics

GET/platform/analytics/metricsPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:read

Authenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.

Query parameters

  • projectIdstring (uuid)

    Identifier of the Polymorfa project that owns this resource.

  • sessionIdstring (uuid)

    One number record UUID, within the authorized project or team.

  • windowHoursintegerrange1–168

    Number of completed UTC hours in the window, ending at the most recent hour boundary. Default 24; maximum 168.

    Default 24
  • segmentsstring

    Include message type, text length, origin, calling-code and device-count breakdowns. Adds metric series.

    Allowed valuestruefalse
    Default "false"
  • formatstring

    Prometheus text 0.0.4 or OpenMetrics text 1.0. The format parameter selects the representation.

    Allowed valuesprometheusopenmetrics
    Default "prometheus"

Responses

  • 200Windowed analytics gauges. OpenMetrics ends with # EOF. No JSON envelope.

    Content typetext/plainapplication/openmetrics-text

    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
  • 503Analytics query deadline exceeded. Retry later or use a shorter window.
GET /platform/analytics/metricscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/analytics/metrics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response

Content type text/plain, application/openmetrics-text

No example for this content type

Export project analytics metrics

GET/platform/projects/{projectId}/analytics/metricsPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:read

Authenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.

Path parameters

  • projectIdstring (uuid)required

    Identifier of the Polymorfa project that owns this resource.

Query parameters

  • sessionIdstring (uuid)

    One number record UUID, within the authorized project or team.

  • windowHoursintegerrange1–168

    Number of completed UTC hours in the window, ending at the most recent hour boundary. Default 24; maximum 168.

    Default 24
  • segmentsstring

    Include message type, text length, origin, calling-code and device-count breakdowns. Adds metric series.

    Allowed valuestruefalse
    Default "false"
  • formatstring

    Prometheus text 0.0.4 or OpenMetrics text 1.0. The format parameter selects the representation.

    Allowed valuesprometheusopenmetrics
    Default "prometheus"

Responses

  • 200Windowed analytics gauges. OpenMetrics ends with # EOF. No JSON envelope.

    Content typetext/plainapplication/openmetrics-text

    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
  • 503Analytics query deadline exceeded. Retry later or use a shorter window.
GET /platform/projects/{projectId}/analytics/metricscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/projects/<projectId>/analytics/metrics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response

Content type text/plain, application/openmetrics-text

No example for this content type

Read team analytics

GET/platform/analyticsPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:read

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.

Query parameters

  • projectIdstring

    Project to read. Omit to total every project in the team.

  • sessionIdstring (uuid)

    Identifier of the connected Polymorfa session.

  • startintegermin0

    Specifies start for this query parameter.

  • endintegermin0

    Specifies end for this query parameter.

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 7 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 404The requested resource was not found inside the authenticated team or project scope.
  • 503The change was stored, but a connected number has not confirmed it. Retry the request; the stored setting is already correct and is retried automatically.
GET /platform/analyticscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "data": {
    "enabled": true,
    "period": {
      "start": 0,
      "end": 0
    },
    "requestVitals": {
      "requests": 0,
      "failures": 0,
      "errorRate": 0
    },
    "summary": {
      "measured": true,
      "observedHours": 0,
      "lastObservedAt": 0,
      "outgoingMessages": 0,
      "incomingMessages": 0,
      "sendAttempts": 0,
      "sendFailures": 0,
      "sendFailureRate": 0,
      "businessReplies": 0,
      "averageBusinessResponseMs": 0,
      "onlineMs": 0,
      "disconnects": 0,
      "connectFailures": 0,
      "streamErrors": 0,
      "keepaliveTimeouts": 0,
      "engagement": {
        "windowHours": 24,
        "completedConversations": 0,
        "deliveredConversations": 0,
        "readConversations": 0,
        "repliedConversations": 0,
        "deliveryRate": 0,
        "readRate": 0,
        "replyRate": 0,
        "averageCustomerReplyMs": 0,
        "complete": true,
        "droppedConversations": 0,
        "droppedRecords": 0,
        "droppedReceiptJoins": 0
      },
      "totalNumbers": 0,
      "measuredNumbers": 0,
      "connectedNumbers": 0,
      "messageAnalysis": {
        "complete": true,
        "segments": [
          {
            "dimension": "message_type",
            "key": "string",
            "sendAttempts": 0,
            "sent": 0,
            "sendFailures": 0,
            "sendFailureRate": 0,
            "completedConversations": 0,
            "deliveredConversations": 0,
            "readConversations": 0,
            "repliedConversations": 0,
            "deliveryRate": 0,
            "readRate": 0,
            "replyRate": 0,
            "averageCustomerReplyMs": 0,
            "shareOfConversations": 0,
            "shareOfSends": 0,
            "readRateInterval95": [
              null
            ],
            "replyRateInterval95": [
              null
            ],
            "readRateDifference": -1,
            "replyRateDifference": -1
          }
        ]
      },
      "customerActivity": {
        "observed": true,
        "onlineSignals": 0,
        "offlineSignals": 0,
        "typingSignals": 0
      },
      "accountActivity": {
        "observed": true,
        "primaryPhoneActivitySignals": 0,
        "primaryPhoneActivePeriods": 0,
        "completedPhoneActivityPeriods": 0,
        "phoneActivityMs": 0,
        "averagePhoneActivityMs": 0,
        "phoneQuietGaps": 0,
        "phoneQuietMs": 0,
        "averagePhoneQuietMs": 0,
        "primaryPhoneMessages": 0,
        "otherDeviceMessages": 0,
        "lastPrimaryPhoneAt": 0,
        "primaryPhoneReplies": 0,
        "otherDeviceReplies": 0,
        "averagePrimaryPhoneResponseMs": 0,
        "averageOtherDeviceResponseMs": 0
      },
      "responseQueue": {
        "awaitingReply": 0,
        "oldestWaitingMs": 0,
        "observedAt": 0,
        "complete": true
      },
      "calls": {
        "total": 0,
        "answered": 0,
        "missed": 0,
        "declined": 0,
        "failed": 0,
        "ringing": 0,
        "answerRate": 0,
        "talkSeconds": 0,
        "timedAnswered": 0,
        "timedPickup": 0,
        "averageTalkSeconds": 0,
        "medianTalkSeconds": 0,
        "p95TalkSeconds": 0,
        "averagePickupMs": 0,
        "p95PickupMs": 0,
        "shortAnswered": 0,
        "video": 0,
        "directions": {
          "inbound": {
            "total": 0,
            "answered": 0,
            "missed": 0,
            "declined": 0,
            "failed": 0,
            "ringing": 0,
            "answerRate": 0,
            "talkSeconds": 0,
            "timedAnswered": 0,
            "timedPickup": 0,
            "averageTalkSeconds": 0,
            "medianTalkSeconds": 0,
            "p95TalkSeconds": 0,
            "averagePickupMs": 0,
            "p95PickupMs": 0,
            "shortAnswered": 0,
            "video": 0
          },
          "outbound": {
            "total": 0,
            "answered": 0,
            "missed": 0,
            "declined": 0,
            "failed": 0,
            "ringing": 0,
            "answerRate": 0,
            "talkSeconds": 0,
            "timedAnswered": 0,
            "timedPickup": 0,
            "averageTalkSeconds": 0,
            "medianTalkSeconds": 0,
            "p95TalkSeconds": 0,
            "averagePickupMs": 0,
            "p95PickupMs": 0,
            "shortAnswered": 0,
            "video": 0
          }
        },
        "mediaQuality": {
          "measuredCalls": 0,
          "averageJitterMs": 0,
          "averageRttMs": 0,
          "packetsLost": 0
        },
        "appQuality": {
          "measuredCalls": 0,
          "averageJitterMs": 0,
          "averageRttMs": 0,
          "packetLossRate": 0,
          "reconnects": 0
        },
        "endReasons": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "appErrors": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "transports": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "multiParticipantCalls": 0,
        "followUp": {
          "eligibleMissed": 0,
          "returnedWithin24h": 0,
          "rate": 0,
          "averageDelayMs": 0,
          "pendingWindow": 0,
          "unknownContact": 0
        }
      },
      "deviceAnalytics": {
        "detector": "message_id_prefix/v1",
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "customerMessages": 0,
        "accountMessages": 0,
        "customerPlatforms": [
          {
            "platform": "web",
            "messages": 0,
            "share": 0
          }
        ],
        "accountPlatforms": [
          {
            "platform": "web",
            "messages": 0,
            "share": 0
          }
        ],
        "inventory": {
          "listObserved": true,
          "listCurrent": true,
          "observedAt": 0,
          "deviceCount": 0,
          "truncated": true,
          "devices": [
            {
              "deviceIndex": null,
              "estimatedPlatform": "web",
              "reportedClass": "phone",
              "lastActiveAt": null,
              "listed": null
            }
          ]
        }
      },
      "conversationBreakdown": {
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "droppedConversations": 0,
        "truncated": true,
        "buckets": [
          {
            "ts": 0,
            "complete": true
          }
        ],
        "rows": [
          {
            "ts": 0,
            "messageType": "text",
            "textBand": "none",
            "origin": "api",
            "recipientCountry": "string",
            "recipientDeviceCount": "primary_only",
            "callingCode": "string",
            "customerDevices": "single",
            "completedConversations": 0,
            "deliveredConversations": 0,
            "readConversations": 0,
            "repliedConversations": 0,
            "replyLatencySumMs": 0,
            "readRate": 0,
            "replyRate": 0,
            "averageCustomerReplyMs": 0
          }
        ]
      }
    },
    "numbers": [
      {
        "sessionId": "00000000-0000-4000-8000-000000000000",
        "projectId": "00000000-0000-4000-8000-000000000000",
        "name": "string",
        "backend": "string",
        "status": "string",
        "measured": true,
        "observedHours": 0,
        "lastObservedAt": 0,
        "outgoingMessages": 0,
        "incomingMessages": 0,
        "sendAttempts": 0,
        "sendFailures": 0,
        "sendFailureRate": 0,
        "businessReplies": 0,
        "averageBusinessResponseMs": 0,
        "onlineMs": 0,
        "disconnects": 0,
        "connectFailures": 0,
        "streamErrors": 0,
        "keepaliveTimeouts": 0,
        "engagement": {
          "windowHours": 24,
          "completedConversations": 0,
          "deliveredConversations": 0,
          "readConversations": 0,
          "repliedConversations": 0,
          "deliveryRate": 0,
          "readRate": 0,
          "replyRate": 0,
          "averageCustomerReplyMs": 0,
          "complete": true,
          "droppedConversations": 0,
          "droppedRecords": 0,
          "droppedReceiptJoins": 0
        },
        "messageAnalysis": {
          "complete": true,
          "segments": [
            {
              "dimension": "message_type",
              "key": null,
              "sendAttempts": null,
              "sent": null,
              "sendFailures": null,
              "sendFailureRate": null,
              "completedConversations": null,
              "deliveredConversations": null,
              "readConversations": null,
              "repliedConversations": null,
              "deliveryRate": null,
              "readRate": null,
              "replyRate": null,
              "averageCustomerReplyMs": null,
              "shareOfConversations": null,
              "shareOfSends": null,
              "readRateInterval95": null,
              "replyRateInterval95": null,
              "readRateDifference": null,
              "replyRateDifference": null
            }
          ]
        },
        "customerActivity": {
          "observed": true,
          "onlineSignals": 0,
          "offlineSignals": 0,
          "typingSignals": 0
        },
        "accountActivity": {
          "observed": true,
          "primaryPhoneActivitySignals": 0,
          "primaryPhoneActivePeriods": 0,
          "completedPhoneActivityPeriods": 0,
          "phoneActivityMs": 0,
          "averagePhoneActivityMs": 0,
          "phoneQuietGaps": 0,
          "phoneQuietMs": 0,
          "averagePhoneQuietMs": 0,
          "primaryPhoneMessages": 0,
          "otherDeviceMessages": 0,
          "lastPrimaryPhoneAt": 0,
          "primaryPhoneReplies": 0,
          "otherDeviceReplies": 0,
          "averagePrimaryPhoneResponseMs": 0,
          "averageOtherDeviceResponseMs": 0
        },
        "responseQueue": {
          "awaitingReply": 0,
          "oldestWaitingMs": 0,
          "observedAt": 0,
          "complete": true
        },
        "projectName": "string",
        "calls": {
          "total": 0,
          "answered": 0,
          "missed": 0,
          "declined": 0,
          "failed": 0,
          "ringing": 0,
          "answerRate": 0,
          "talkSeconds": 0,
          "timedAnswered": 0,
          "timedPickup": 0,
          "averageTalkSeconds": 0,
          "medianTalkSeconds": 0,
          "p95TalkSeconds": 0,
          "averagePickupMs": 0,
          "p95PickupMs": 0,
          "shortAnswered": 0,
          "video": 0,
          "directions": {
            "inbound": {
              "total": null,
              "answered": null,
              "missed": null,
              "declined": null,
              "failed": null,
              "ringing": null,
              "answerRate": null,
              "talkSeconds": null,
              "timedAnswered": null,
              "timedPickup": null,
              "averageTalkSeconds": null,
              "medianTalkSeconds": null,
              "p95TalkSeconds": null,
              "averagePickupMs": null,
              "p95PickupMs": null,
              "shortAnswered": null,
              "video": null
            },
            "outbound": {
              "total": null,
              "answered": null,
              "missed": null,
              "declined": null,
              "failed": null,
              "ringing": null,
              "answerRate": null,
              "talkSeconds": null,
              "timedAnswered": null,
              "timedPickup": null,
              "averageTalkSeconds": null,
              "medianTalkSeconds": null,
              "p95TalkSeconds": null,
              "averagePickupMs": null,
              "p95PickupMs": null,
              "shortAnswered": null,
              "video": null
            }
          },
          "mediaQuality": {
            "measuredCalls": 0,
            "averageJitterMs": 0,
            "averageRttMs": 0,
            "packetsLost": 0
          },
          "appQuality": {
            "measuredCalls": 0,
            "averageJitterMs": 0,
            "averageRttMs": 0,
            "packetLossRate": 0,
            "reconnects": 0
          },
          "endReasons": [
            {
              "code": null,
              "count": null
            }
          ],
          "appErrors": [
            {
              "code": null,
              "count": null
            }
          ],
          "transports": [
            {
              "code": null,
              "count": null
            }
          ],
          "multiParticipantCalls": 0,
          "followUp": {
            "eligibleMissed": 0,
            "returnedWithin24h": 0,
            "rate": 0,
            "averageDelayMs": 0,
            "pendingWindow": 0,
            "unknownContact": 0
          }
        },
        "deviceAnalytics": {
          "detector": "message_id_prefix/v1",
          "measured": true,
          "complete": true,
          "observedBuckets": 0,
          "customerMessages": 0,
          "accountMessages": 0,
          "customerPlatforms": [
            {
              "platform": "web",
              "messages": null,
              "share": null
            }
          ],
          "accountPlatforms": [
            {
              "platform": "web",
              "messages": null,
              "share": null
            }
          ],
          "inventory": {
            "listObserved": true,
            "listCurrent": true,
            "observedAt": 0,
            "deviceCount": 0,
            "truncated": true,
            "devices": [
              null
            ]
          }
        },
        "conversationBreakdown": {
          "measured": true,
          "complete": true,
          "observedBuckets": 0,
          "droppedConversations": 0,
          "truncated": true,
          "buckets": [
            {
              "ts": null,
              "complete": null
            }
          ],
          "rows": [
            {
              "ts": null,
              "messageType": "text",
              "textBand": "none",
              "origin": "api",
              "recipientCountry": null,
              "recipientDeviceCount": "primary_only",
              "callingCode": null,
              "customerDevices": "single",
              "completedConversations": null,
              "deliveredConversations": null,
              "readConversations": null,
              "repliedConversations": null,
              "replyLatencySumMs": null,
              "readRate": null,
              "replyRate": null,
              "averageCustomerReplyMs": null
            }
          ]
        }
      }
    ],
    "series": [
      {
        "ts": 0,
        "outgoingMessages": 0,
        "incomingMessages": 0,
        "sendFailures": 0,
        "businessReplies": 0,
        "averageBusinessResponseMs": 0,
        "onlineMs": 0,
        "disconnects": 0,
        "sessionId": "00000000-0000-4000-8000-000000000000",
        "customerOnlineSignals": 0,
        "customerTypingSignals": 0,
        "primaryPhoneMessages": 0,
        "otherDeviceMessages": 0,
        "primaryPhoneReplies": 0,
        "phoneActivePeriods": 0,
        "completedPhoneActivityPeriods": 0,
        "phoneActivityMs": 0,
        "phoneQuietGaps": 0,
        "phoneQuietMs": 0
      }
    ],
    "callSeries": [
      {
        "total": 0,
        "answered": 0,
        "missed": 0,
        "declined": 0,
        "failed": 0,
        "ringing": 0,
        "answerRate": 0,
        "talkSeconds": 0,
        "timedAnswered": 0,
        "timedPickup": 0,
        "averageTalkSeconds": 0,
        "medianTalkSeconds": 0,
        "p95TalkSeconds": 0,
        "averagePickupMs": 0,
        "p95PickupMs": 0,
        "shortAnswered": 0,
        "video": 0,
        "sessionId": "00000000-0000-4000-8000-000000000000",
        "ts": 0
      }
    ]
  }
}

Read project analytics

GET/platform/projects/{projectId}/analyticsPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:read

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.

Path parameters

  • projectIdstring (uuid)required

    Identifier of the Polymorfa project that owns this resource.

Query parameters

  • sessionIdstring (uuid)

    Identifier of the connected Polymorfa session.

  • startintegermin0

    Specifies start for this query parameter.

  • endintegermin0

    Specifies end for this query parameter.

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 7 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 404The requested resource was not found inside the authenticated team or project scope.
  • 503The change was stored, but a connected number has not confirmed it. Retry the request; the stored setting is already correct and is retried automatically.
GET /platform/projects/{projectId}/analyticscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/projects/<projectId>/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "data": {
    "enabled": true,
    "period": {
      "start": 0,
      "end": 0
    },
    "requestVitals": {
      "requests": 0,
      "failures": 0,
      "errorRate": 0
    },
    "summary": {
      "measured": true,
      "observedHours": 0,
      "lastObservedAt": 0,
      "outgoingMessages": 0,
      "incomingMessages": 0,
      "sendAttempts": 0,
      "sendFailures": 0,
      "sendFailureRate": 0,
      "businessReplies": 0,
      "averageBusinessResponseMs": 0,
      "onlineMs": 0,
      "disconnects": 0,
      "connectFailures": 0,
      "streamErrors": 0,
      "keepaliveTimeouts": 0,
      "engagement": {
        "windowHours": 24,
        "completedConversations": 0,
        "deliveredConversations": 0,
        "readConversations": 0,
        "repliedConversations": 0,
        "deliveryRate": 0,
        "readRate": 0,
        "replyRate": 0,
        "averageCustomerReplyMs": 0,
        "complete": true,
        "droppedConversations": 0,
        "droppedRecords": 0,
        "droppedReceiptJoins": 0
      },
      "totalNumbers": 0,
      "measuredNumbers": 0,
      "connectedNumbers": 0,
      "messageAnalysis": {
        "complete": true,
        "segments": [
          {
            "dimension": "message_type",
            "key": "string",
            "sendAttempts": 0,
            "sent": 0,
            "sendFailures": 0,
            "sendFailureRate": 0,
            "completedConversations": 0,
            "deliveredConversations": 0,
            "readConversations": 0,
            "repliedConversations": 0,
            "deliveryRate": 0,
            "readRate": 0,
            "replyRate": 0,
            "averageCustomerReplyMs": 0,
            "shareOfConversations": 0,
            "shareOfSends": 0,
            "readRateInterval95": [
              null
            ],
            "replyRateInterval95": [
              null
            ],
            "readRateDifference": -1,
            "replyRateDifference": -1
          }
        ]
      },
      "customerActivity": {
        "observed": true,
        "onlineSignals": 0,
        "offlineSignals": 0,
        "typingSignals": 0
      },
      "accountActivity": {
        "observed": true,
        "primaryPhoneActivitySignals": 0,
        "primaryPhoneActivePeriods": 0,
        "completedPhoneActivityPeriods": 0,
        "phoneActivityMs": 0,
        "averagePhoneActivityMs": 0,
        "phoneQuietGaps": 0,
        "phoneQuietMs": 0,
        "averagePhoneQuietMs": 0,
        "primaryPhoneMessages": 0,
        "otherDeviceMessages": 0,
        "lastPrimaryPhoneAt": 0,
        "primaryPhoneReplies": 0,
        "otherDeviceReplies": 0,
        "averagePrimaryPhoneResponseMs": 0,
        "averageOtherDeviceResponseMs": 0
      },
      "responseQueue": {
        "awaitingReply": 0,
        "oldestWaitingMs": 0,
        "observedAt": 0,
        "complete": true
      },
      "calls": {
        "total": 0,
        "answered": 0,
        "missed": 0,
        "declined": 0,
        "failed": 0,
        "ringing": 0,
        "answerRate": 0,
        "talkSeconds": 0,
        "timedAnswered": 0,
        "timedPickup": 0,
        "averageTalkSeconds": 0,
        "medianTalkSeconds": 0,
        "p95TalkSeconds": 0,
        "averagePickupMs": 0,
        "p95PickupMs": 0,
        "shortAnswered": 0,
        "video": 0,
        "directions": {
          "inbound": {
            "total": 0,
            "answered": 0,
            "missed": 0,
            "declined": 0,
            "failed": 0,
            "ringing": 0,
            "answerRate": 0,
            "talkSeconds": 0,
            "timedAnswered": 0,
            "timedPickup": 0,
            "averageTalkSeconds": 0,
            "medianTalkSeconds": 0,
            "p95TalkSeconds": 0,
            "averagePickupMs": 0,
            "p95PickupMs": 0,
            "shortAnswered": 0,
            "video": 0
          },
          "outbound": {
            "total": 0,
            "answered": 0,
            "missed": 0,
            "declined": 0,
            "failed": 0,
            "ringing": 0,
            "answerRate": 0,
            "talkSeconds": 0,
            "timedAnswered": 0,
            "timedPickup": 0,
            "averageTalkSeconds": 0,
            "medianTalkSeconds": 0,
            "p95TalkSeconds": 0,
            "averagePickupMs": 0,
            "p95PickupMs": 0,
            "shortAnswered": 0,
            "video": 0
          }
        },
        "mediaQuality": {
          "measuredCalls": 0,
          "averageJitterMs": 0,
          "averageRttMs": 0,
          "packetsLost": 0
        },
        "appQuality": {
          "measuredCalls": 0,
          "averageJitterMs": 0,
          "averageRttMs": 0,
          "packetLossRate": 0,
          "reconnects": 0
        },
        "endReasons": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "appErrors": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "transports": [
          {
            "code": "string",
            "count": 0
          }
        ],
        "multiParticipantCalls": 0,
        "followUp": {
          "eligibleMissed": 0,
          "returnedWithin24h": 0,
          "rate": 0,
          "averageDelayMs": 0,
          "pendingWindow": 0,
          "unknownContact": 0
        }
      },
      "deviceAnalytics": {
        "detector": "message_id_prefix/v1",
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "customerMessages": 0,
        "accountMessages": 0,
        "customerPlatforms": [
          {
            "platform": "web",
            "messages": 0,
            "share": 0
          }
        ],
        "accountPlatforms": [
          {
            "platform": "web",
            "messages": 0,
            "share": 0
          }
        ],
        "inventory": {
          "listObserved": true,
          "listCurrent": true,
          "observedAt": 0,
          "deviceCount": 0,
          "truncated": true,
          "devices": [
            {
              "deviceIndex": null,
              "estimatedPlatform": "web",
              "reportedClass": "phone",
              "lastActiveAt": null,
              "listed": null
            }
          ]
        }
      },
      "conversationBreakdown": {
        "measured": true,
        "complete": true,
        "observedBuckets": 0,
        "droppedConversations": 0,
        "truncated": true,
        "buckets": [
          {
            "ts": 0,
            "complete": true
          }
        ],
        "rows": [
          {
            "ts": 0,
            "messageType": "text",
            "textBand": "none",
            "origin": "api",
            "recipientCountry": "string",
            "recipientDeviceCount": "primary_only",
            "callingCode": "string",
            "customerDevices": "single",
            "completedConversations": 0,
            "deliveredConversations": 0,
            "readConversations": 0,
            "repliedConversations": 0,
            "replyLatencySumMs": 0,
            "readRate": 0,
            "replyRate": 0,
            "averageCustomerReplyMs": 0
          }
        ]
      }
    },
    "numbers": [
      {
        "sessionId": "00000000-0000-4000-8000-000000000000",
        "projectId": "00000000-0000-4000-8000-000000000000",
        "name": "string",
        "backend": "string",
        "status": "string",
        "measured": true,
        "observedHours": 0,
        "lastObservedAt": 0,
        "outgoingMessages": 0,
        "incomingMessages": 0,
        "sendAttempts": 0,
        "sendFailures": 0,
        "sendFailureRate": 0,
        "businessReplies": 0,
        "averageBusinessResponseMs": 0,
        "onlineMs": 0,
        "disconnects": 0,
        "connectFailures": 0,
        "streamErrors": 0,
        "keepaliveTimeouts": 0,
        "engagement": {
          "windowHours": 24,
          "completedConversations": 0,
          "deliveredConversations": 0,
          "readConversations": 0,
          "repliedConversations": 0,
          "deliveryRate": 0,
          "readRate": 0,
          "replyRate": 0,
          "averageCustomerReplyMs": 0,
          "complete": true,
          "droppedConversations": 0,
          "droppedRecords": 0,
          "droppedReceiptJoins": 0
        },
        "messageAnalysis": {
          "complete": true,
          "segments": [
            {
              "dimension": "message_type",
              "key": null,
              "sendAttempts": null,
              "sent": null,
              "sendFailures": null,
              "sendFailureRate": null,
              "completedConversations": null,
              "deliveredConversations": null,
              "readConversations": null,
              "repliedConversations": null,
              "deliveryRate": null,
              "readRate": null,
              "replyRate": null,
              "averageCustomerReplyMs": null,
              "shareOfConversations": null,
              "shareOfSends": null,
              "readRateInterval95": null,
              "replyRateInterval95": null,
              "readRateDifference": null,
              "replyRateDifference": null
            }
          ]
        },
        "customerActivity": {
          "observed": true,
          "onlineSignals": 0,
          "offlineSignals": 0,
          "typingSignals": 0
        },
        "accountActivity": {
          "observed": true,
          "primaryPhoneActivitySignals": 0,
          "primaryPhoneActivePeriods": 0,
          "completedPhoneActivityPeriods": 0,
          "phoneActivityMs": 0,
          "averagePhoneActivityMs": 0,
          "phoneQuietGaps": 0,
          "phoneQuietMs": 0,
          "averagePhoneQuietMs": 0,
          "primaryPhoneMessages": 0,
          "otherDeviceMessages": 0,
          "lastPrimaryPhoneAt": 0,
          "primaryPhoneReplies": 0,
          "otherDeviceReplies": 0,
          "averagePrimaryPhoneResponseMs": 0,
          "averageOtherDeviceResponseMs": 0
        },
        "responseQueue": {
          "awaitingReply": 0,
          "oldestWaitingMs": 0,
          "observedAt": 0,
          "complete": true
        },
        "projectName": "string",
        "calls": {
          "total": 0,
          "answered": 0,
          "missed": 0,
          "declined": 0,
          "failed": 0,
          "ringing": 0,
          "answerRate": 0,
          "talkSeconds": 0,
          "timedAnswered": 0,
          "timedPickup": 0,
          "averageTalkSeconds": 0,
          "medianTalkSeconds": 0,
          "p95TalkSeconds": 0,
          "averagePickupMs": 0,
          "p95PickupMs": 0,
          "shortAnswered": 0,
          "video": 0,
          "directions": {
            "inbound": {
              "total": null,
              "answered": null,
              "missed": null,
              "declined": null,
              "failed": null,
              "ringing": null,
              "answerRate": null,
              "talkSeconds": null,
              "timedAnswered": null,
              "timedPickup": null,
              "averageTalkSeconds": null,
              "medianTalkSeconds": null,
              "p95TalkSeconds": null,
              "averagePickupMs": null,
              "p95PickupMs": null,
              "shortAnswered": null,
              "video": null
            },
            "outbound": {
              "total": null,
              "answered": null,
              "missed": null,
              "declined": null,
              "failed": null,
              "ringing": null,
              "answerRate": null,
              "talkSeconds": null,
              "timedAnswered": null,
              "timedPickup": null,
              "averageTalkSeconds": null,
              "medianTalkSeconds": null,
              "p95TalkSeconds": null,
              "averagePickupMs": null,
              "p95PickupMs": null,
              "shortAnswered": null,
              "video": null
            }
          },
          "mediaQuality": {
            "measuredCalls": 0,
            "averageJitterMs": 0,
            "averageRttMs": 0,
            "packetsLost": 0
          },
          "appQuality": {
            "measuredCalls": 0,
            "averageJitterMs": 0,
            "averageRttMs": 0,
            "packetLossRate": 0,
            "reconnects": 0
          },
          "endReasons": [
            {
              "code": null,
              "count": null
            }
          ],
          "appErrors": [
            {
              "code": null,
              "count": null
            }
          ],
          "transports": [
            {
              "code": null,
              "count": null
            }
          ],
          "multiParticipantCalls": 0,
          "followUp": {
            "eligibleMissed": 0,
            "returnedWithin24h": 0,
            "rate": 0,
            "averageDelayMs": 0,
            "pendingWindow": 0,
            "unknownContact": 0
          }
        },
        "deviceAnalytics": {
          "detector": "message_id_prefix/v1",
          "measured": true,
          "complete": true,
          "observedBuckets": 0,
          "customerMessages": 0,
          "accountMessages": 0,
          "customerPlatforms": [
            {
              "platform": "web",
              "messages": null,
              "share": null
            }
          ],
          "accountPlatforms": [
            {
              "platform": "web",
              "messages": null,
              "share": null
            }
          ],
          "inventory": {
            "listObserved": true,
            "listCurrent": true,
            "observedAt": 0,
            "deviceCount": 0,
            "truncated": true,
            "devices": [
              null
            ]
          }
        },
        "conversationBreakdown": {
          "measured": true,
          "complete": true,
          "observedBuckets": 0,
          "droppedConversations": 0,
          "truncated": true,
          "buckets": [
            {
              "ts": null,
              "complete": null
            }
          ],
          "rows": [
            {
              "ts": null,
              "messageType": "text",
              "textBand": "none",
              "origin": "api",
              "recipientCountry": null,
              "recipientDeviceCount": "primary_only",
              "callingCode": null,
              "customerDevices": "single",
              "completedConversations": null,
              "deliveredConversations": null,
              "readConversations": null,
              "repliedConversations": null,
              "replyLatencySumMs": null,
              "readRate": null,
              "replyRate": null,
              "averageCustomerReplyMs": null
            }
          ]
        }
      }
    ],
    "series": [
      {
        "ts": 0,
        "outgoingMessages": 0,
        "incomingMessages": 0,
        "sendFailures": 0,
        "businessReplies": 0,
        "averageBusinessResponseMs": 0,
        "onlineMs": 0,
        "disconnects": 0,
        "sessionId": "00000000-0000-4000-8000-000000000000",
        "customerOnlineSignals": 0,
        "customerTypingSignals": 0,
        "primaryPhoneMessages": 0,
        "otherDeviceMessages": 0,
        "primaryPhoneReplies": 0,
        "phoneActivePeriods": 0,
        "completedPhoneActivityPeriods": 0,
        "phoneActivityMs": 0,
        "phoneQuietGaps": 0,
        "phoneQuietMs": 0
      }
    ],
    "callSeries": [
      {
        "total": 0,
        "answered": 0,
        "missed": 0,
        "declined": 0,
        "failed": 0,
        "ringing": 0,
        "answerRate": 0,
        "talkSeconds": 0,
        "timedAnswered": 0,
        "timedPickup": 0,
        "averageTalkSeconds": 0,
        "medianTalkSeconds": 0,
        "p95TalkSeconds": 0,
        "averagePickupMs": 0,
        "p95PickupMs": 0,
        "shortAnswered": 0,
        "video": 0,
        "sessionId": "00000000-0000-4000-8000-000000000000",
        "ts": 0
      }
    ]
  }
}