Get Short Link data by Campaign-ID

GET

/short_link_campaigns/{code}

Retrieve a specific Short Link Campaign by it’s ID. If the Campaign is not found then the HTTP code response will be 404.

Authorizations

token

Parameters

Path Parameters

code

required

string

>= 1 characters <= 36 characters

Short_link_campaigns code

Responses

200

Short_link_campaigns resource

Short link campaigns

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

type

Tipo da campanha de links curtos

integer

Allowed values: 1 2

Identificador único da campanha de links curtos

string | null

name

Nome da campanha de links curtos

string

>= 1 characters <= 100 characters

url

URL da campanha de links curtos

string

>= 1 characters

created_at

Timestamp when the entity was added to the system by the user

integer

group_id

ID do grupo da campanha de links curtos

integer | null

>= 1

Example

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "type": 1
}

Short link campaigns

object

type

Tipo da campanha de links curtos

integer

Allowed values: 1 2

Identificador único da campanha de links curtos

string | null

name

Nome da campanha de links curtos

string

>= 1 characters <= 100 characters

url

URL da campanha de links curtos

string

>= 1 characters

created_at

Timestamp when the entity was added to the system by the user

integer

group_id

ID do grupo da campanha de links curtos

integer | null

>= 1

Example

{
  "type": 1
}

401

Client ID or API key isn’t active or invalid!

403

Account isn’t activated. Please wait or contact to support!

404

Resource not found

429

O endereço IP foi bloqueado temporariamente, pois durante um curto período de tempo foram enviadas várias solicitações com credenciais inválidas. Aguarde e tente mais tarde.

Code Samples

const url = 'https://api.lox24.eu/short_link_campaigns/example';
const options = {method: 'GET', headers: {'X-LOX24-AUTH-TOKEN': '<X-LOX24-AUTH-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://api.lox24.eu/short_link_campaigns/example \
  --header 'X-LOX24-AUTH-TOKEN: <X-LOX24-AUTH-TOKEN>'