Get Link Tracking Profile

GET

/api/v1/workspaces/{workspace_id}/link_tracking_profiles/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/link_tracking_profiles/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/link_tracking_profiles/1 \
  --header 'Authorization: Bearer <token>'

Retrieves a link_tracking_profile.

Authorizations

OAuth2
link_tracking_profiles:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

Link Tracking Profile ID

Responses

200

Successful

application/json

object

required

integer

name

required

string

parameters

Array

One of:

object

type

required

string

Allowed values: fixed_value

parameter

required

The URL query parameter name.

string

value

required

The fixed value for this parameter.

string

label

string | null

hint

string | null

custom_template

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "id": 12345,
  "name": "My Link Tracking Profile",
  "parameters": [
    {
      "type": "fixed_value",
      "parameter": "utm_source",
      "value": "newsletter"
    }
  ],
  "custom_template": "{{ url }}",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}