Zprávy

Poznámky
Expert level
API klíč by měl být odeslán jako token Bearer v záhlaví Authorization požadavku. Získat váš API klíč.
Seznam

API koncový bod:

GET 
https://hoxseo.red/api/v1/reports

Příklad požadavku: 

curl --location --request GET 'https://hoxseo.red/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
volitelné string
Vyhledávací dotaz.
search_by
volitelné string
Hledat podle. Možné hodnoty jsou: url pro URL. Výchozí hodnota: url.
project
volitelné string
Název projektu.
result
volitelné string
The report result. Možné hodnoty jsou: good pro Dobré, decent pro Přijatelné, bad pro Špatné.
sort_by
volitelné string
Seřadit podle. Možné hodnoty jsou: id pro Datum vytvoření, generated_at pro Datum generování, url pro URL, result pro Výsledek. Výchozí hodnota: id.
sort
volitelné string
Seřadit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.
per_page
volitelné integer
Výsledky na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 10.
Zobrazit

API koncový bod:

GET 
https://hoxseo.red/api/v1/reports/{id}

Příklad požadavku: 

curl --location --request GET 'https://hoxseo.red/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Obchod

API koncový bod:

POST 
https://hoxseo.red/api/v1/reports

Příklad požadavku: 

curl --location --request POST 'https://hoxseo.red/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametr
Typ
Popis
url
povinné string
The webpage's URL.
privacy
volitelné integer
Report page privacy. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo. Výchozí hodnota: 0.
password
volitelné string
The password for the report page. Only works with privacy set to 2.
Aktualizovat

API koncový bod:

PUT PATCH 
https://hoxseo.red/api/v1/reports/{id}

Příklad požadavku: 

curl --location --request PUT 'https://hoxseo.red/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
privacy
volitelné integer
Report page privacy. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo.
password
volitelné string
The password for the report page. Only works with privacy set to 2.
results
volitelné integer
Update the report results. Možné hodnoty jsou: 0 pro Ne, 1 pro Ano. Výchozí hodnota: 0.
Smazat

API koncový bod:

DELETE 
https://hoxseo.red/api/v1/reports/{id}

Příklad požadavku: 

curl --location --request DELETE 'https://hoxseo.red/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'