Get a single link - Tapper Documentation

GET

links

{id}

curl --request GET \
  --url https://itlinks.to/v1/links/{id} \
  --header 'Authorization: <api-key>'

{
  "data": {
    "id": 1001,
    "name": "Example Link 1",
    "domain": "example.com",
    "slug": "example-link-1",
    "tags": [
      "tag1",
      "tag2"
    ],
    "rules": [
      {
        "id": 10001,
        "name": "Morning Rule",
        "active_from": "2023-01-01",
        "active_to": "2023-12-31",
        "locations": [
          {
            "type": "country",
            "name": "USA"
          }
        ],
        "device_types": [
          "Mobile",
          "Desktop"
        ],
        "oses": [
          "Windows",
          "iOS"
        ],
        "week_days": [
          "Monday",
          "Tuesday",
          "Wednesday"
        ],
        "day_time_ranges": [
          {
            "start": "08:00",
            "end": "12:00"
          }
        ],
        "url_ratios": [
          {
            "name": "Primary URL",
            "url": "http://example.com/main",
            "ratio": 0.8
          },
          {
            "name": "Secondary URL",
            "url": "http://example.com/secondary",
            "ratio": 0.2
          }
        ],
        "created_at": "2023-01-01T00:00:00"
      },
      {
        "id": 10002,
        "name": "Evening Rule",
        "active_from": "2023-01-01",
        "active_to": "2023-12-31",
        "locations": [
          {
            "type": "country",
            "name": "USA"
          }
        ],
        "device_types": [
          "Mobile",
          "Desktop"
        ],
        "oses": [
          "Windows",
          "iOS"
        ],
        "week_days": [
          "Monday",
          "Tuesday",
          "Wednesday"
        ],
        "day_time_ranges": [
          {
            "start": "18:00",
            "end": "21:00"
          }
        ],
        "url_ratios": [
          {
            "name": "General URL",
            "url": "http://example.com/general",
            "ratio": 0.8
          }
        ],
        "created_at": "2023-01-01T00:00:00"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

number

required

Required range: x >= 1

Response

200

application/json

Link retrieved successfully.

data

object

data.id

number

The unique identifier of the link.

Required range: x >= 1

data.name

string

The name of the link.

Maximum length: 320

data.domain

string

The domain associated with the link.

Maximum length: 253

data.slug

string

A URL-friendly identifier for the link.

Maximum length: 320

data.tags

string[] | null

A list of tags for categorizing the link.

data.rules

object[]

A list of rules associated with the link.

data.rules.id

number

The unique identifier of the rule.

Required range: x >= 1

data.rules.name

string | null

The name of the rule.

Maximum length: 320

data.rules.active_from

string

The starting date from which the rule is active.

data.rules.active_to

string | null

The ending date until which the rule is active.

data.rules.locations

object[] | null

A list of locations where the rule applies.

data.rules.device_types

enum<string>[] | null

The types of devices targeted by the rule.

Available options:

Desktop,

Mobile,

Tablet,

iPod,

SmartTV,

Console,

Wearable,

Embedded,

Curl,

Bot

data.rules.oses

enum<string>[] | null

The operating systems targeted by the rule.

Available options:

Mac OS,

iOS,

Android,

Windows,

Windows Mobile OS

data.rules.week_days

enum<string>[] | null

The days of the week when the rule is active.

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

data.rules.day_time_ranges

object[] | null

The time ranges during the day when the rule is active.

data.rules.url_ratios

object[] | null

A list of URL ratios defining how different URLs should be distributed.

data.rules.created_at

string

The timestamp when the rule was created.

Create a new link Update a link

curl --request GET \
  --url https://itlinks.to/v1/links/{id} \
  --header 'Authorization: <api-key>'

{
  "data": {
    "id": 1001,
    "name": "Example Link 1",
    "domain": "example.com",
    "slug": "example-link-1",
    "tags": [
      "tag1",
      "tag2"
    ],
    "rules": [
      {
        "id": 10001,
        "name": "Morning Rule",
        "active_from": "2023-01-01",
        "active_to": "2023-12-31",
        "locations": [
          {
            "type": "country",
            "name": "USA"
          }
        ],
        "device_types": [
          "Mobile",
          "Desktop"
        ],
        "oses": [
          "Windows",
          "iOS"
        ],
        "week_days": [
          "Monday",
          "Tuesday",
          "Wednesday"
        ],
        "day_time_ranges": [
          {
            "start": "08:00",
            "end": "12:00"
          }
        ],
        "url_ratios": [
          {
            "name": "Primary URL",
            "url": "http://example.com/main",
            "ratio": 0.8
          },
          {
            "name": "Secondary URL",
            "url": "http://example.com/secondary",
            "ratio": 0.2
          }
        ],
        "created_at": "2023-01-01T00:00:00"
      },
      {
        "id": 10002,
        "name": "Evening Rule",
        "active_from": "2023-01-01",
        "active_to": "2023-12-31",
        "locations": [
          {
            "type": "country",
            "name": "USA"
          }
        ],
        "device_types": [
          "Mobile",
          "Desktop"
        ],
        "oses": [
          "Windows",
          "iOS"
        ],
        "week_days": [
          "Monday",
          "Tuesday",
          "Wednesday"
        ],
        "day_time_ranges": [
          {
            "start": "18:00",
            "end": "21:00"
          }
        ],
        "url_ratios": [
          {
            "name": "General URL",
            "url": "http://example.com/general",
            "ratio": 0.8
          }
        ],
        "created_at": "2023-01-01T00:00:00"
      }
    ]
  }
}