GET Reports/Calls?page={page}&campaignId={campaignId}&poolId={poolId}&start={start}&end={end}&source={source}&call_id={call_id}

Get calls
CauseCode values -- 1 - Answered, 2 - Missed (Line busy), 3 - Missed (Unanswered), 4 - Missed (Cancelled), 0 - Unknown

Returns

HTTP 200, 206 (when page is not last)

Request Information

Parameters

NameDescriptionAdditional information
page 
Page index

Define this parameter in the request URI.

This parameter is optional.
campaignId 
Filter by campaign ID

Define this parameter in the request URI.

This parameter is optional.
poolId 
Filter by pool ID

Define this parameter in the request URI.

This parameter is optional.
start 
Date of period start

Define this parameter in the request URI.

This parameter is optional.
end 
Date of period end

Define this parameter in the request URI.

This parameter is optional.
source 
Filter by source

Define this parameter in the request URI.

This parameter is optional.
call_id 
Filter by call uuid

Define this parameter in the request URI.

This parameter is optional.

Response Information

Response body formats

application/json, text/json, text/html

Sample: 
[
  {
    "ID": 1,
    "CallID": "2a71824b-53b8-4727-898f-2ab5092123f9",
    "BeginAt": "2024-11-20T05:35:43.9292023Z",
    "EndedAt": "2024-11-20T05:37:43.9292023Z",
    "Duration": 120,
    "Number": "1300123457",
    "Caller": "0212345678",
    "DestinationNumber": "0212345678",
    "CauseCode": 1,
    "PhonePoolID": 1,
    "CampaignID": 1,
    "Rating": 3,
    "CallValue": 1,
    "ReturningCallID": null,
    "DownloadLink": "http://download.site.com/1.mp3",
    "Country": "au",
    "State": "NSW",
    "Region": "Albury",
    "SuburbName": "Burrumbuttock",
    "VoicemailLink": "http://download.site.com/vm-1.mp3",
    "SurveyAnswers": null,
    "Postcode": null,
    "Visitors": [
      {
        "VisitorID": "2c8095f5-1f7f-4376-ace5-b0b8ce350600",
        "Created": "2024-11-20T05:34:43.9292023Z",
        "LastPoll": "2024-11-20T05:37:33.9292023Z",
        "Referrer": "http://google.com/",
        "Ip": "8.8.8.8",
        "RankPosition": 6,
        "Keywords": "blue pills",
        "AdwordsOriginalPage": "",
        "AdwordsPreviousPage": "",
        "PreviousQuery": "",
        "OriginalQuery": "",
        "IsPersonalized": true,
        "SearchSource": "",
        "IsCombinedTraffic": false,
        "UtmSource": "",
        "UtmMedium": "",
        "UtmTerm": "",
        "UtmContent": "",
        "UtmCampaign": "",
        "AssignedPhone": "",
        "DeviceParameter": "",
        "AdwordsKeyword": "",
        "Type": "Organic",
        "LandingPageUrl": "http://example.com/landing-page/?gclid=CKG7raXy48gCFQnbvAodbBkNAg",
        "GCLID": "CKG7raXy48gCFQnbvAodbBkNAg",
        "CustomAttributes": {
          "k1": "v1",
          "k2": "v2",
          "k3": "v3"
        }
      }
    ]
  },
  {
    "ID": 1,
    "CallID": "242a718b-53b8-728f-8947-509f92a2123b",
    "BeginAt": "2024-11-20T05:17:43.9292023Z",
    "EndedAt": "2024-11-20T05:27:43.9292023Z",
    "Duration": 600,
    "Number": "1300123457",
    "Caller": "0455545678",
    "DestinationNumber": "0212345678",
    "CauseCode": 1,
    "PhonePoolID": 1,
    "CampaignID": 1,
    "Rating": 3,
    "CallValue": 1,
    "ReturningCallID": null,
    "DownloadLink": "http://download.site.com/2.mp3",
    "Country": null,
    "State": null,
    "Region": null,
    "SuburbName": null,
    "VoicemailLink": "http://download.site.com/vm-2.mp3",
    "SurveyAnswers": null,
    "Postcode": "1234",
    "Visitors": []
  }
]

application/xml, text/xml

Sample: 
<ArrayOfApiCall xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CallTracker.Api.Models">
  <ApiCall>
    <BeginAt>2024-11-20T05:35:43.9292023Z</BeginAt>
    <CallID>2a71824b-53b8-4727-898f-2ab5092123f9</CallID>
    <CallValue>1</CallValue>
    <Caller>0212345678</Caller>
    <CampaignID>1</CampaignID>
    <CauseCode>1</CauseCode>
    <Country>au</Country>
    <DestinationNumber>0212345678</DestinationNumber>
    <DownloadLink>http://download.site.com/1.mp3</DownloadLink>
    <Duration>120</Duration>
    <EndedAt>2024-11-20T05:37:43.9292023Z</EndedAt>
    <ID>1</ID>
    <Number>1300123457</Number>
    <PhonePoolID>1</PhonePoolID>
    <Postcode i:nil="true" />
    <Rating>3</Rating>
    <Region>Albury</Region>
    <ReturningCallID i:nil="true" />
    <State>NSW</State>
    <SuburbName>Burrumbuttock</SuburbName>
    <SurveyAnswers i:nil="true" />
    <Visitors>
      <ApiVisitor>
        <AdwordsKeyword></AdwordsKeyword>
        <AdwordsOriginalPage></AdwordsOriginalPage>
        <AdwordsPreviousPage></AdwordsPreviousPage>
        <AssignedPhone></AssignedPhone>
        <Created>2024-11-20T05:34:43.9292023Z</Created>
        <CustomAttributes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>k1</d5p1:Key>
            <d5p1:Value>v1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>k2</d5p1:Key>
            <d5p1:Value>v2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>k3</d5p1:Key>
            <d5p1:Value>v3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </CustomAttributes>
        <DeviceParameter></DeviceParameter>
        <GCLID>CKG7raXy48gCFQnbvAodbBkNAg</GCLID>
        <Ip>8.8.8.8</Ip>
        <IsCombinedTraffic>false</IsCombinedTraffic>
        <IsPersonalized>true</IsPersonalized>
        <Keywords>blue pills</Keywords>
        <LandingPageUrl>http://example.com/landing-page/?gclid=CKG7raXy48gCFQnbvAodbBkNAg</LandingPageUrl>
        <LastPoll>2024-11-20T05:37:33.9292023Z</LastPoll>
        <OriginalQuery></OriginalQuery>
        <PreviousQuery></PreviousQuery>
        <RankPosition>6</RankPosition>
        <Referrer>http://google.com/</Referrer>
        <SearchSource></SearchSource>
        <Type>Organic</Type>
        <UtmCampaign></UtmCampaign>
        <UtmContent></UtmContent>
        <UtmMedium></UtmMedium>
        <UtmSource></UtmSource>
        <UtmTerm></UtmTerm>
        <VisitorID>2c8095f5-1f7f-4376-ace5-b0b8ce350600</VisitorID>
      </ApiVisitor>
    </Visitors>
    <VoicemailLink>http://download.site.com/vm-1.mp3</VoicemailLink>
  </ApiCall>
  <ApiCall>
    <BeginAt>2024-11-20T05:17:43.9292023Z</BeginAt>
    <CallID>242a718b-53b8-728f-8947-509f92a2123b</CallID>
    <CallValue>1</CallValue>
    <Caller>0455545678</Caller>
    <CampaignID>1</CampaignID>
    <CauseCode>1</CauseCode>
    <Country i:nil="true" />
    <DestinationNumber>0212345678</DestinationNumber>
    <DownloadLink>http://download.site.com/2.mp3</DownloadLink>
    <Duration>600</Duration>
    <EndedAt>2024-11-20T05:27:43.9292023Z</EndedAt>
    <ID>1</ID>
    <Number>1300123457</Number>
    <PhonePoolID>1</PhonePoolID>
    <Postcode>1234</Postcode>
    <Rating>3</Rating>
    <Region i:nil="true" />
    <ReturningCallID i:nil="true" />
    <State i:nil="true" />
    <SuburbName i:nil="true" />
    <SurveyAnswers i:nil="true" />
    <Visitors />
    <VoicemailLink>http://download.site.com/vm-2.mp3</VoicemailLink>
  </ApiCall>
</ArrayOfApiCall>