Report

Appunti
Expert level
La chiave API deve essere inviata come token Bearer nell'intestazione Authorization della richiesta. Ottieni la tua chiave API.
Elenco

Endpoint API:

GET 
https://teleskop.it/api/v1/reports

Richiedi esempio: 

curl --location --request GET 'https://teleskop.it/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametro
Tipo
Descrizione
search
opzionale string
Search query.
search_by
opzionale string
Cercato da. I valori possibili sono: url per :nome. Il valore predefinito è url.
project
opzionale string
Project name
result
opzionale string
The report result. I valori possibili sono: good per :nome, decent per :nome, bad per :nome.
sort_by
opzionale string
Ordina per. I valori possibili sono: id per :nome, generated_at per :nome, url per :nome, score per :nome. Il valore predefinito è id.
sort
opzionale string
Ordinare. I valori possibili sono: desc per :nome, asc per :nome. Il valore predefinito è desc.
per_page
opzionale integer
Risultati per pagina. I valori possibili sono: 10, 25, 50, 100. Il valore predefinito è 10.
Mostra

Endpoint API:

GET 
https://teleskop.it/api/v1/reports/{id}

Richiedi esempio: 

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

Endpoint API:

POST 
https://teleskop.it/api/v1/reports

Richiedi esempio: 

curl --location --request POST 'https://teleskop.it/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametro
Tipo
Descrizione
url
necessario string
The webpage's URL.
privacy
opzionale integer
Report page privacy. I valori possibili sono: 0 per :nome, 1 per :nome, 2 per :nome. Il valore predefinito è 0.
password
opzionale string
The password for the report page. Only works with privacy field set to 2.
Aggiorna

Endpoint API:

PUT PATCH 
https://teleskop.it/api/v1/reports/{id}

Richiedi esempio: 

curl --location --request PUT 'https://teleskop.it/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametro
Tipo
Descrizione
privacy
opzionale integer
Report page privacy. I valori possibili sono: 0 per :nome, 1 per :nome, 2 per :nome.
password
opzionale string
The password for the report page. Only works with privacy field set to 2.
update
opzionale integer
Aggiorna. I valori possibili sono: 0 per :nome, 1 per :nome. Il valore predefinito è 0.
Eliminare

Endpoint API:

DELETE 
https://teleskop.it/api/v1/reports/{id}

Richiedi esempio: 

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