Try Free for 14 DaysRequest A Demo

API Documentation - Tracking

The tracking resource allows you to retrieve phone numbers and web forms.

Tracking Instance Resources

MethodEndpointDescription
GET/api/v1/tracking/numbersGet a paginated list of details for all phone numbers.
GET/api/v1/tracking/formsGet a paginated list of details for all web forms.

Get All Phone Numbers

Get a paginated list of details for all phone numbers.

Resource Details

MethodEndpoint
GEThttps://app.whatconverts.com/api/v1/tracking/numbers

Supported Parameters

ParameterTypeDescriptionRequired
numbers_per_pagenumberNumber of phone numbers to return for this request (default 25, maximum 250).No
page_numbernumberPage number to return for this request.No
account_idnumberUnique identifier for the account in which to return phone numbers from. Supported when using an Agency Key.No
profile_idnumberUnique identifier for the profile in which to return phone numbers from. Supported when using an Agency Key.No

Response Details

ParameterTypeDescription
numbers_per_pagenumberThe number of phone numbers returned in the request.
page_numbernumberThe current page number in the request.
total_pagesnumberThe total amount of pages available in the request.
total_numbersnumberThe total amount of phone numbers available in the request.
numbersarrayContains all the requested phone numbers.
account_idnumberUnique identifier for the account.
profile_idnumberUnique identifier for the profile.
profilestringThe name of the profile.
phone_number_idnumberUnique identifier for the phone number.
phone_namestringThe name of the phone number.
tracking_numbernumberThe tracking number is the phone number.
tracking_number_iso_countrystringThe two-letter ISO country code for the tracking number.
destination_numbernumberThe destination number for this phone number.
destination_number_iso_countrystringThe two-letter ISO country code for the destination number.
swap_numbernumberThe swap number for this phone number.
call_flowstringThe call flow for this phone number.
triggerstringThe trigger for this phone number.
sourcestringThe source specified for the trigger.
mediumstringThe medium specified for the trigger.
last_usedstringThe last time the phone number was assigned to a user in a dynamic number pool.
call_recordingbooleanThe call recording status of this phone number.
voicebooleanThe voice status of this phone number.
messagingbooleanThe messaging status of this phone number.
pending_activationbooleanThe pending activation status of this phone number.

Example Response

	{
	  "page_number": 1,
	  "numbers_per_page": 25,
	  "total_pages": 37,
	  "total_numbers": 910,
	  "numbers": [
	    {
	      "account_id": 13744,
	      "profile_id": 42167,
	      "profile": "WhatConverts",
	      "phone_number_id": 148099,
	      "phone_name": "Search Paid",
	      "tracking_number": 16863152111,
	      "tracking_number_iso_country": "US",
	      "destination_number": 18112556580,
	      "destination_number_iso_country": "US",
	      "swap_number": 8112556580,
	      "call_flow": null,
	      "trigger": "Pool: All Traffic",
	      "source": null,
	      "medium": null,
	      "last_used": "2019-07-16T23:37:02Z",
	      "call_recording": true,
	      "voice": true,
	      "messaging": true,
	      "pending_activation": false
	    },
	    ...
	  ]
	}
	

Get All Web Forms

Get a paginated list of details for all web forms.

Resource Details

MethodEndpoint
GEThttps://app.whatconverts.com/api/v1/tracking/forms

Supported Parameters

ParameterTypeDescriptionRequired
forms_per_pagenumberNumber of web forms to return for this request (default 25, maximum 250).No
page_numbernumberPage number to return for this request.No
account_idnumberUnique identifier for the account in which to return web forms from. Supported when using an Agency Key.No
profile_idnumberUnique identifier for the profile in which to return web forms from. Supported when using an Agency Key.No

Response Details

ParameterTypeDescription
forms_per_pagenumberThe number of web forms returned in the request.
page_numbernumberThe current page number in the request.
total_pagesnumberThe total amount of pages available in the request.
total_formsnumberThe total amount of web forms available in the request.
formsarrayContains all the requested web forms.
account_idnumberUnique identifier for the account.
profile_idnumberUnique identifier for the profile.
profilestringThe name of the profile.
form_idnumberUnique identifier for the web form.
form_namestringThe name of the web form.
attribute_typestringThe attribute type for this web form.
attribute_type_valuestringThe attribute type value for this web form.
submit_attribute_typestringThe submit attribute type for this web form.
submit_attribute_type_valuestringThe submit attribute type value for this web form.

Example Response

	{
	  "page_number": 1,
	  "forms_per_page": 25,
	  "total_pages": 37,
	  "total_forms": 910,
	  "forms": [
	    {
	      "account_id": 13744,
	      "profile_id": 42167,
	      "profile": "WhatConverts",
	      "form_id": 148099,
	      "form_name": "Contact Us",
	      "attribute_type": "ID",
	      "attribute_type_value": "contact_us",
	      "submit_attribute_type": "Class",
	      "submit_attribute_type_value": "submit_button"
	    },
	    ...
	  ]
	}