Odkazy

Autorizace

Klíč API by měl být odeslán jako token Bearer v hlavičce Authorization požadavku. Získejte klíč API.

Seznam

Koncový bod API

GET

https://sqzr.cz/api/v1/links

Příklad žádosti

curl --location --request GET 'https://sqzr.cz/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parametry

Název / Jméno

Typ

Popis

search

volitelné string

Search query.

search_by

volitelné string

Hledat dle. Možné hodnoty jsou: title pro Název, alias pro Alias, url pro URL. Výchozí hodnota: title.

status

volitelné integer

Stav. Možné hodnoty jsou: 0 pro Vše, 1 pro Aktivní, 2 pro Vypršela platnost, 3 pro Neaktivní. Výchozí hodnota: 0.

space_id

volitelné integer

ID prostoru.

domain_id

volitelné integer

ID domény.

pixel_id

volitelné integer

Pixel ID.

sort_by

volitelné string

Řadit dle. Možné hodnoty jsou: id pro Vytvořeno, clicks pro Kliknutí, title pro Název, alias pro Alias, url pro URL. Výchozí hodnota: id.

sort

volitelné string

Třídit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.

per_page

volitelné integer

Výsledků na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 50.

Zobrazit

Koncový bod API

GET

https://sqzr.cz/api/v1/links/{id}

Příklad žádosti

curl --location --request GET 'https://sqzr.cz/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Ukládat

Koncový bod API

POST

https://sqzr.cz/api/v1/links

Příklad žádosti

curl --location --request POST 'https://sqzr.cz/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'

Parametry

Název / Jméno

Typ

Popis

url

vyžadováno string

Cílové URL.

domain_id

vyžadováno integer

ID domény.

alias

volitelné string

Alias.

space_id

volitelné integer

ID prostoru.

pixel_ids[]

volitelné array

Pixel ID.

redirect_password

volitelné string

Heslo pro přesměrování.

sensitive_content

volitelné integer

Citlivý obsah. Možné hodnoty jsou: 0 pro Ne, 1 pro Ano. Výchozí hodnota: 0.

privacy

volitelné integer

Soukromí statistik. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo. Výchozí hodnota: 0.

password

volitelné string

Heslo statistik. Only works with privacy field set to 2.

active_period_start_at

volitelné string

Datum začátku aktivního období ve formátu Y-m-dTH:i:s.

active_period_end_at

volitelné string

Datum konce aktivního období ve formátu Y-m-dTH:i:s.

clicks_limit

volitelné integer

Limit kliknutí.

expiration_url

volitelné string

URL po expiraci.

targets_type

volitelné string

Cílení. Možné hodnoty jsou: continents pro Continents, countries pro Countries, operating_systems pro Operating systems, browsers pro Browsers, languages pro Languages, devices pro Devices, rotations pro Rotations.

targets[index][key]

volitelné string

Pro targets_type=country musí být hodnota ve formátu ISO 3166-1 alpha-2.

Pro targets_type=operating_systems jsou možné hodnoty: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Pro targets_type=browsers jsou možné hodnoty: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.

Pro targets_type=devices jsou možné hodnoty: Desktop, Mobile, Tablet, Watch, Television.

Pro targets_type=languages musí být hodnota ve formátu ISO 639-1 alpha-2.

Pro targets_type=continents jsou možné hodnoty: AF pro Africa, AN pro Antarctica, AS pro Asia, EU pro Europe, NA pro North America, OC pro Oceania, SA pro South America.

targets[index][value]

volitelné string

Cílové URL.

Aktualizovat

Koncový bod API

PUT PATCH

https://sqzr.cz/api/v1/links/{id}

Příklad žádosti

curl --location --request PUT 'https://sqzr.cz/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parametry

Název / Jméno

Typ

Popis

url

volitelné string

Cílové URL.

alias

volitelné string

Alias.

space_id

volitelné integer

ID prostoru.

pixel_ids[]

volitelné array

Pixel ID.

redirect_password

volitelné string

Heslo pro přesměrování.

sensitive_content

volitelné integer

Citlivý obsah. Možné hodnoty jsou: 0 pro Ne, 1 pro Ano.

privacy

volitelné integer

Soukromí statistik. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo.

password

volitelné string

Heslo statistik. Only works with privacy field set to 2.

active_period_start_at

volitelné string

Datum začátku aktivního období ve formátu Y-m-dTH:i:s.

active_period_end_at

volitelné string

Datum konce aktivního období ve formátu Y-m-dTH:i:s.

clicks_limit

volitelné integer

Limit kliknutí.

expiration_url

volitelné string

URL po expiraci.

targets_type

volitelné string

targets[index][key]

volitelné string

Pro targets_type=country musí být hodnota ve formátu ISO 3166-1 alpha-2.

Pro targets_type=operating_systems jsou možné hodnoty: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Pro targets_type=devices jsou možné hodnoty: Desktop, Mobile, Tablet, Watch, Television.

Pro targets_type=languages musí být hodnota ve formátu ISO 639-1 alpha-2.

Pro targets_type=continents jsou možné hodnoty: AF pro Africa, AN pro Antarctica, AS pro Asia, EU pro Europe, NA pro North America, OC pro Oceania, SA pro South America.

targets[index][value]

volitelné string

Cílové URL.

Odstranit

Koncový bod API

DELETE

https://sqzr.cz/api/v1/links/{id}

Příklad žádosti

curl --location --request DELETE 'https://sqzr.cz/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'