API Documentation - Tracking

Tracking Instance Resources

Method	Endpoint	Description
GET	/api/v1/tracking/numbers	Get a paginated list of details for all phone numbers.
DELETE	/api/v1/tracking/numbers/{phone_number_id}	Delete a single phone number.
GET	/api/v1/tracking/forms	Get a paginated list of details for all web forms.
DELETE	/api/v1/tracking/forms/{form_id}	Delete a single web form.

Get All Phone Numbers

Get a paginated list of details for all phone numbers.

Resource Details

Method	Endpoint
GET	https://app.whatconverts.com/api/v1/tracking/numbers

Supported Parameters

Parameter	Type	Description	Required
`numbers_per_page`	number	Number of phone numbers to return for this request (default 25, maximum 250).	No
`page_number`	number	Page number to return for this request.	No
`account_id`	number	Unique identifier for the account in which to return phone numbers from. Supported when using an Agency Key.	No
`profile_id`	number	Unique identifier for the profile in which to return phone numbers from. Supported when using an Agency Key.	No

Response Details

Parameter	Type	Description
`numbers_per_page`	number	The number of phone numbers returned in the request.
`page_number`	number	The current page number in the request.
`total_pages`	number	The total amount of pages available in the request.
`total_numbers`	number	The total amount of phone numbers available in the request.
`numbers`	array	Contains all the requested phone numbers.
`account_id`	number	Unique identifier for the account.
`profile_id`	number	Unique identifier for the profile.
`profile`	string	The name of the profile.
`phone_number_id`	number	Unique identifier for the phone number.
`phone_name`	string	The name of the phone number.
`tracking_number`	number	The tracking number is the phone number.
`tracking_number_iso_country`	string	The two-letter ISO country code for the `tracking number`.
`destination_number`	number	The destination number for this phone number.
`destination_number_iso_country`	string	The two-letter ISO country code for the `destination number`.
`swap_number`	number	The swap number for this phone number.
`call_flow`	string	The call flow for this phone number.
`trigger`	string	The trigger for this phone number.
`source`	string	The source specified for the `trigger`.
`medium`	string	The medium specified for the `trigger`.
`last_used`	string	The last time the phone number was assigned to a user in a dynamic number pool.
`call_recording`	boolean	The call recording status of this phone number.
`voice`	boolean	The voice status of this phone number.
`messaging`	boolean	The messaging status of this phone number.
`pending_activation`	boolean	The 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
	    },
	    ...
	  ]
	}

Delete Phone Number

Delete a single phone number.

Notice After deleting you will no longer be able to track phone calls for this phone number.

Resource Details

Method	Endpoint
DELETE	https://app.whatconverts.com/api/v1/tracking/numbers/{phone_number_id}

Supported Parameters

No supported parameters.

Response Details

Parameter	Type	Description
`phone_number_id`	number	Unique identifier for the phone number.

Example Response

    {
      "phone_number_id": 2548713
    }

Get All Web Forms

Get a paginated list of details for all web forms.

Resource Details

Method	Endpoint
GET	https://app.whatconverts.com/api/v1/tracking/forms

Supported Parameters

Parameter	Type	Description	Required
`forms_per_page`	number	Number of web forms to return for this request (default 25, maximum 250).	No
`page_number`	number	Page number to return for this request.	No
`account_id`	number	Unique identifier for the account in which to return web forms from. Supported when using an Agency Key.	No
`profile_id`	number	Unique identifier for the profile in which to return web forms from. Supported when using an Agency Key.	No

Response Details

Parameter	Type	Description
`forms_per_page`	number	The number of web forms returned in the request.
`page_number`	number	The current page number in the request.
`total_pages`	number	The total amount of pages available in the request.
`total_forms`	number	The total amount of web forms available in the request.
`forms`	array	Contains all the requested web forms.
`account_id`	number	Unique identifier for the account.
`profile_id`	number	Unique identifier for the profile.
`profile`	string	The name of the profile.
`form_id`	number	Unique identifier for the web form.
`form_name`	string	The name of the web form.
`attribute_type`	string	The attribute type for this web form.
`attribute_type_value`	string	The attribute type value for this web form.
`submit_attribute_type`	string	The submit attribute type for this web form.
`submit_attribute_type_value`	string	The 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"
	    },
	    ...
	  ]
	}