Skip to content
Documentation

List Link Tracking Profiles

GET
/api/v1/workspaces/{workspace_id}/link_tracking_profiles
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/link_tracking_profiles?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

Retrieves the link_tracking_profiles.

Authorizations

Section titled “Authorizations”
  • OAuth2
    link_tracking_profiles:read

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
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
nullable
hint
string
nullable
custom_template
string
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "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"
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}