Try Free for 14 DaysRequest A Demo

API Documentation - Profiles

The profiles resource allows you to retrieve, edit, add, and delete profiles.

Profiles Instance Resources

MethodEndpointDescription
GET/api/v1/accounts/{account_id}/profilesGet a paginated list of details for all profiles.
GET/api/v1/accounts/{account_id}/profiles/{profile_id}Get details about a single profile.
POST/api/v1/accounts/{account_id}/profilesCreate a new profile.
POST/api/v1/accounts/{account_id}/profiles/{profile_id}Edit details for a single profile.
DELETE/api/v1/accounts/{account_id}/profiles/{profile_id}Delete a single profile.

Get All Profiles

Get a paginated list of details for all profiles.

Resource Details

MethodEndpoint
GEThttps://app.whatconverts.com/api/v1/accounts/{account_id}/profiles

Supported Parameters

ParameterTypeDescriptionRequired
profiles_per_pagenumberNumber of profiles to return for this request (default 25, maximum 250).No
page_numbernumberPage number to return for this request.No
start_datestringStart date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z.No
end_datestringEnd date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z.No
orderstringOrder in which to return the profiles by date created; asc or (default) desc.No

Response Details

ParameterTypeDescription
profiles_per_pagenumberThe number of profiles returned in the request.
page_numbernumberThe current page number in the request.
total_pagesnumberThe total amount of pages available in the request.
total_profilesnumberThe total amount of profiles available in the request.
profilesarrayContains all the requested profiles.
profile_idnumberUnique identifier for the profile.
profile_namestringThe name of the profile.
date_createdstringDate and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "page_number": 1,
      "profiles_per_page": 25,
      "total_pages": 2,
      "total_profiles": 45,
      "profiles": [
        {
          "profile_id": 2548713,
          "profile_name": "WhatConverts Tracking",
          "date_created": "2016-06-24T17:24:42Z"
        },
        ...
      ]
    }
    

Get Single Profile

Get details for specific profile.

Resource Details

MethodEndpoint
GEThttps://app.whatconverts.com/api/v1/accounts/{account_id}/profiles/{profile_id}

Supported Parameters

No supported parameters.

Response Details

Includes all response details from get all profiles resource.

Create New Profile

Create a new profile.

Resource Details

MethodEndpoint
POSThttps://app.whatconverts.com/api/v1/accounts/{account_id}/profiles

Supported Parameters

ParameterTypeDescriptionRequired
profile_namestringThe name for this profileYes

Response Details

ParameterTypeDescription
profile_idnumberUnique identifier for the profile.
profile_namestringThe name of the profile.
date_createdstringDate and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "profile_id": 2548713,
      "profile_name": "WhatConverts Tracking",
      "date_created": "2016-06-24T17:24:42Z"
    }
    

Edit Profile

Edit details for a single profile.

Resource Details

MethodEndpoint
POSThttps://app.whatconverts.com/api/v1/accounts/{account_id}/profiles/{profile_id}

Supported Parameters

ParameterTypeDescriptionRequired
profile_namestringThe name for this profileYes

Response Details

ParameterTypeDescription
profile_idnumberUnique identifier for the profile.
profile_namestringThe name of the profile.
date_createdstringDate and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "profile_id": 2548713,
      "profile_name": "WhatConverts Tracking",
      "date_created": "2016-06-24T17:24:42Z"
    }
    

Delete Profile

Delete a single profile.

Resource Details

MethodEndpoint
DELETEhttps://app.whatconverts.com/api/v1/accounts/{account_id}/profiles/{profile_id}

Supported Parameters

No supported parameters.

Response Details

ParameterTypeDescription
profile_idnumberUnique identifier for the profile.

Example Response

    {
      "profile_id": 2548713
    }