Skip to main content

Get list of calls​

If no parameter is indicated, will return today's

Query Parameters
  • offset integer

    The number of items to skip before starting to collect the result set

  • limit integer

    The numbers of items to return. If not present, results will be limited to 3000 items

  • from_id integer

    The call id from which to start the response dataset

  • from_date string

    The from date for which to retrieve call data. Formatted as ISO 8601 without time

  • to_date string

    The to date for which to retrieve call data. Formatted as ISO 8601 without time

  • type integer

    Possible values: [static, outbound, dynamic]

    The type of campaign you wish to filter the response dataset by

  • campaign_id integer

    The id of the campaign you wish to filter the response dataset by

  • va_code string

    The va_code of the dynamic URL you wish to filter the response dataset by

  • callers_number string

    This needs to be E.164 with no leading +

Responses
Schema array
  • id integer

    The ID of the call

  • reference string

    Telecoms provider call reference

  • service_number string

    Possible values: Value must match regular expression ^[0-9]{1,14}$

    The service number that was called

  • destination_number string

    Possible values: Value must match regular expression ^[0-9]{1,14}$

    The terminating number of the call

  • callers_number string

    Possible values: Value must match regular expression ^[0-9]{1,14}$

    The number that initiated the call

  • start_date string

    Start date of the call. Formatted as ISO 8601 without time

  • start_time string

    Start time of the call. Formatted as ISO 8601 without date

  • direction string

    Possible values: [inbound, outbound]

    The direction of the call

  • status string

    Possible values: [Engaged, Successful, Unanswered]

    The status of the call

  • recording_url string

    The URL of the call recording if available

  • campaign_description string

    The description of the campaign this call belongs to

  • last_source string

    The location from which the caller originated before making the phone call. Only available on dynamic calls

  • last_medium string

    The medium from which the caller originated before making the phone call. Only available on dynamic calls

  • first_source string

    The location where the caller first found your website. Only available for dynamic calls

  • first_medium string

    The medium from which the caller first found your website. Only available for dynamic calls

  • visit_id integer
  • visitor_id integer

    The ID of the visitor. Only available on dynamic calls

  • click_id string

    The Google Click ID (gclid), Microsoft Click ID (msclkid) or the Facebook Click ID (fbclid) of the caller. To determine paid ad platform served the click id, use the value of the PaidSearchType field. Only available on paid search dynamic calls

  • media_description string

    The media description of the call. Only available on static calls

  • media_channel string

    The media channel of the call. Only available on static calls

  • media_owner string

    The media owner of the call. Only available on static calls

  • department string

    The department of the call. Only available on static calls

  • call_length string

    The length of the call (in minutes)

  • ring_length string

    The ring length of the call

  • town string

    The town where the call was made

  • county string

    The county where the call was made

  • postcode string

    The postcode where the call was made

  • number_type string

    Possible values: [access, directory, geographic, international, mobile, other, premium]

  • region string

    The region where the call was made

  • tags string

    A string containing the tag value pairs, with multiple tag value pairs these are separated by a ‘|’. e.g. “tag1=value1|tag2=Value2”

  • value string

    The value of the call

  • call_category string

    The call scoring category

  • page_uri string

    The web page seen when the call was made

  • page_title string

    Page title

  • landing_page_uri string

    The landing page of the visit that resulted in a call

  • landing_page_title string

    Visitor Call Tracking, Telephone Tracking

  • paid_search_type string

    Possible values: [Adwords, Bing Ads, Facebook Ads, N/A]

    The type of paid search

  • paid_search_match_type string

    Possible values: [broad, exact, phrase]

    The type of paid search match

  • paid_search_ad_group_id integer

    Ad group id

  • paid_search_ad_group_name string
  • paid_search_campaign_id integer

    Ad campaign id

  • paid_search_campaign_name string

    Ad campaign name

  • google_client_id string

    Google client identifier

  • pool_description string

    The description of the dynamic pool the call was made on

  • device_type string

    Visitor's device type

  • device_brand string

    Visitor's device brand

  • device_model string

    Visitor's device model

  • browser string

    Visitor's device browser

  • os string

    Visitor's device operating system

  • os_version string

    Visitor's operating system version

  • ad_network string

    Possible values: [display, search, partner]

    The ad network

  • first_click_keyword string

    Keyword for visitor's first visit

  • last_click_keyword string

    Search keyword used to find the website

  • agent string

    Outbound agent name

  • account string

    Account name

  • number_description string

    Number's description

  • referring_url string

    Referring URL

  • visit_start_time string
  • visit_end_time string
  • ip_address string

    IP address of the visitor

  • page_path string
  • page_host_name string
  • notes string
  • score string
  • campaign_number_cost string
  • recording_paused string

    Possible values: [no, yes]

  • influencing_source_mediums string

    List of sources/mediums from visits before the call was made

  • call_mhid string

    we0MYHK304

  • visitor_mhid string

    The MHID of the visitor, if the call is dynamic, otherwise blank

  • visit_mhid string

    The MHID of the visit, if the call is dynamic, otherwise blank

  • voice_tags object[]
  • name string

    The name of the voice tag

  • match_type string

    Possible values: [broad, exact]

    The match type - either 'exact' or 'broad'. A broad match includes all the words of the phrase but not necessarily in the same order as the phrase or with extra words interspersed with the words of the phrase. An exact match contains the exact phrase as written with no extra words

  • phrase string

    The phrase matched in the call

  • matched_date_time string

    The date and time of when a voice tag was matched on a call. Formatted as ISO 8601