Browse the API reference

Campaigns

Get campaign statistics

View as Markdown
gethttps://www.getrevox.com/api/campaigns/{id}/statistics

Retrieve the "Statistiques" report for a campaign: the four-tile cascade funnel (appelés → eus en ligne → réels échanges → leads chauds), two secondary tiles, the distribution of exchanges by outcome, the list of hot leads, and data-extraction coverage. All counts are over distinct E.164-normalized phone numbers, and the outcome-based categories derive exclusively from calls.outcome. Cascade percentages are null when their denominator is zero.

Path parameters

  • idstringrequired

Responses

200Success
  • statisticsobjectrequired
    Show 9 fields
    • campaignobjectrequired
      Show 10 fields
      • idstringrequired
      • namestringrequired
      • statusenum (string)required

        One ofrunningpausedcompleted

      • is_cancelledbooleanrequired
      • first_activity_atanyrequirednullable
      • last_activity_atanyrequirednullable
      • agent_namestringrequirednullable
      • max_attempts_per_contactnumberrequirednullable
      • timezonestringrequired
      • has_activitybooleanrequired
    • funnelobjectrequired
      Show 4 fields
      • calledobjectrequired
        Show 2 fields
        • countnumberrequired
        • imported_rowsnumberrequired
      • reachedobjectrequired
        Show 5 fields
        • countnumberrequired
        • outboundnumberrequired
        • inboundnumberrequired
        • overlapnumberrequired
        • pct_of_callednumberrequirednullable
      • real_exchangesobjectrequired
        Show 2 fields
        • countnumberrequired
        • pct_of_reachednumberrequirednullable
      • hot_leadsobjectrequired
        Show 2 fields
        • countnumberrequired
        • pct_of_reachednumberrequirednullable
    • effortobjectrequired
      Show 3 fields
      • calls_totalnumberrequired
      • outbound_attemptsnumberrequired
      • inbound_callsnumberrequired
    • inboundobjectrequired
      Show 1 field
      • unique_callersnumberrequired
    • jump_inobjectrequired
      Show 3 fields
      • joined_callsnumberrequired
      • median_time_to_join_secondsnumberrequirednullable
      • median_conversation_secondsnumberrequirednullable
    • outcome_breakdownarray of objectrequired
      Show 3 fields
      • outcomestringrequired
      • labelstringrequired
      • countnumberrequired
    • hot_lead_outcomesarray of stringrequired
    • data_extractionobjectrequirednullable
      Show 2 fields
      • introstringrequired
      • fieldsarray of stringrequired
    • leadsobjectrequired
      Show 2 fields
      • interestedarray of objectrequired
        Show 8 fields
        • namestringrequired
        • phonestringrequired
        • emailstringrequirednullable
        • directionenum (string)required

          One ofinboundoutbound

        • summarystringrequirednullable
        • last_activity_atanyrequired
        • call_idstringrequired
        • attempt_idstringrequirednullable
      • callback_requestedarray of objectrequired
        Show 8 fields
        • namestringrequired
        • phonestringrequired
        • emailstringrequirednullable
        • directionenum (string)required

          One ofinboundoutbound

        • summarystringrequirednullable
        • last_activity_atanyrequired
        • call_idstringrequired
        • attempt_idstringrequirednullable
404Not found in your organization
  • errorstringrequired