v1

latestSwagger 2.02026-08-06114161439.7 KB
call

List of call metrics per group

Retrieves aggregated call metrics grouped by organizational units. Returns call volume statistics, performance indicators, and analytics rolled up by group hierarchy. Useful for management reporting and cross-team comparisons. Supports pagination and filtering.

get/call/groupActivity

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

Comma separated list of field column name with conditional (=, !=, <=, >=, >, <, like) followed by the value to compare against, Please make sure to add spaces after and before while using "like" operator example "call_flow_name like test_name". Filterable fields include call_started, group_name, group_id, disposition, duration, caller_id, tracking_number, ring_to, campaign_name, call_flow_name and repeat_call.

secondarystring string

Parmameter to specify the secondary grouping for the result. Allowed values: "campaign" or "call_flow"

timezonestring string

To be used in conjunction with the filter param call_started field. Allows the user to specify which timezone is being used for the call_started filter value. Example value: "America/New_York"

Response

Aggregated call metrics and performance data per organizational group

group_namestring string

The name of the group for which the data is aggregated

group_idinteger

The group id to which the calls belong

campaign_namestring string

The campaign name to which the calls belong (only returned if secondary param is set to "campaign")

campaign_ext_idinteger

The campaign external id to which the calls belong (only returned if secondary param is set to "campaign")

campaign_idinteger

The campaign id to which the calls belong (only returned if secondary param is set to "campaign")

call_flow_namestring string

The call flow name to which the calls belong (only returned if secondary param is set to "call_flow")

tracking_numberinteger

The tracking number of the call flow to which the calls belong (only returned if secondary param is set to "call_flow")

call_flow_idinteger

The campaign id to which the calls belong (only returned if secondary param is set to "call_flow")

total_callsinteger

The count of calls for the group

call_valueinteger

The sum of the value of all calls for the group

unique_callsinteger

The count of unique calls for the group

answeredinteger

The count of answered calls for the group

voicemailinteger

The count of calls that were not answered

conversioninteger

The count of calls determined to be a conversion by the conversation analytics engine

total_leadsinteger

The count of calls determined to be a lead by the conversation analytics engine

bill_minutesinteger

The sum of billed minutes for all calls for the group