Data formats

Understand identifiers, timestamps, optional fields, activities, and KPI values.

  • IDs: UUID strings unless field description says otherwise.
  • Timestamps: ISO-8601 date-time strings, normally UTC, such as 2026-08-20T10:30:00.000Z.
  • Reporting dates: YYYY-MM-DD; start and end are inclusive in selected time zone.
  • Time zones: IANA names such as Europe/Berlin. Metrics use workspace reporting time zone when omitted.
  • Durations and KPI times: seconds.
  • Phone queries: normalized international form for normalizedPhoneNumber.
  • Currency: EUR, USD, or GBP.
  • Optional fields: omitted when unavailable or feature-disabled.
  • pipelineGenerated: explicitly null when workspace average deal size is not configured.

Endpoint-specific behavior

Calls

  • statusFilter=connected: conversation happened.
  • statusFilter=noAnswer: conversation did not happen.
  • No status filter: all workspace calls, including queued records.
  • Filtered call-history groups exclude queued records.
  • listName appears when call was placed from dialer list and preserves name captured at call time.
  • transcriptionSummary appears only when summary exists and workspace AI note taker is enabled.
  • Meeting fields appear only when meeting information exists.

Prospects and activities

  • Every prospect includes stable Sonik id.
  • Profile and company fields can be omitted.
  • Prospect activities require normalizedPhoneNumber or email; phone takes priority when both exist.
  • Missing prospect returns 404.
  • Activity union can contain call, SMS, note, and task records. Fields depend on activity type.

Users and metrics

  • Users endpoint has no pagination or filters, excludes deleted users, and has no guaranteed ordering.
  • Metrics date range is inclusive.
  • Optional timeZone must be valid IANA name.
  • pipelineGenerated.amount equals meetings booked multiplied by configured workspace average deal size.

Did this page help you?