Browse the API reference

Calls

Export calls history

View as Markdown
posthttps://www.getrevox.com/api/call/export

Export a list of call attempts as a CSV file. Large exports are split into several files of at most 4MB each: when the response carries a non-null next_offset, call the endpoint again with that value as offset to get the next file.

Request body

  • filtersobjectrequired
    Show 16 fields
    • querystring
    • statusesarray of enum (string)required

      Default []

    • directionsarray of enum (string)required

      Default []

    • resultsarray of enum (string)required

      Default []

    • outcomesarray of enum (string)required

      Default []

    • assistant_idsarray of stringrequired

      Default []

    • campaign_idsarray of stringrequired

      Default []

    • from_phone_numbersarray of stringrequired

      Default []

    • assignee_idsarray of one ofrequired

      Default []

      Show 2 variants

      1. One ofstringstring

      2. One ofstringstring (constant)

    • variablesarray of object
      Show 2 fields
      • keystringrequired
      • valuestringrequired
    • to_phone_numberstring
    • call_idsarray of string
    • pageintegerrequired

      min 1 · max 9007199254740991Default 1

    • page_sizeintegerrequired

      min 1 · max 50000Default 50000

    • sort_bystring
    • sort_directionenum (string)

      One ofascdesc

  • offsetintegerrequired

    Number of already-exported rows to skip, within the filters' page/page_size window. Pass the next_offset value from the previous response to fetch the next file of a split export.

    min 0 · max 9007199254740991Default 0

  • include_structured_output_fieldsboolean

    Whether to include the structured output fields in the CSV file. These are generated by our AI agent during call analysis phase.

  • include_metadataboolean

    Whether to include the metadata in the CSV file. These are the fields you (optionally) attached when placing the call.

Responses

200Success
  • csvstringrequired
  • filenamestringrequired
  • next_offsetintegerrequirednullable

    Non-null when the export was split because this file reached the 4MB cap: pass it as offset in a follow-up call to get the next file. Null when this file completes the export.

    min -9007199254740991 · max 9007199254740991