Projects
Tutte le risposte sono in formato JSON e racchiuse in { "data": ... }. Gli errori restituiscono { "error": "..." } con un codice di stato HTTP appropriato.
Creare un progetto
Section titled Creare un progettoCrea un nuovo progetto specificandone il name e, facoltativamente, la platform.
Metodo
Section titled MetodoPOST
/public/projects
Payload
Section titled Payload| Nome | Tipo | Descrizione |
|---|---|---|
| name | string | Il nome del progetto (obbligatorio, max 200 caratteri) |
| platform | string | Piattaforma del progetto: web (predefinita) o ios |
Header della richiesta
Section titled Header della richiestaAuthorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Codici di stato
Section titled Codici di stato200: progetto creato, restituito nel body
400: body non valido, nome mancante o troppo lungo, piattaforma sconosciuta oppure nome già esistente
Esempio di richiesta
Section titled Esempio di richiestacurl -X POST \
{BASE_URL}/public/projects \
-H 'content-type: application/json' \
-H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
--data-raw '{
"name": "MyFirstProject",
"platform": "web"
}'
Esempio di risposta
Section titled Esempio di risposta{
"data": {
"projectId": 42,
"name": "MyFirstProject",
"projectKey": "QsLA07Oa5sqTfwnNaFwS",
"tenantId": 1,
"maxSessionDuration": 7200000,
"sampleRate": 100,
"saveRequestPayloads": false,
"beaconSize": 0,
"platform": "web",
"metadata1": null,
"metadata2": null,
"metadata3": null,
"metadata4": null,
"metadata5": null,
"metadata6": null,
"metadata7": null,
"metadata8": null,
"metadata9": null,
"metadata10": null
}
}
Elencare i progetti
Section titled Elencare i progettiRestituisce tutti i progetti del tenant corrente.
Metodo
Section titled MetodoGET
/public/projects
Header della richiesta
Section titled Header della richiestaAuthorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Esempio di richiesta
Section titled Esempio di richiestacurl -X GET \
{BASE_URL}/public/projects \
-H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'
Esempio di risposta
Section titled Esempio di risposta{
"data": [
{
"projectId": 42,
"name": "MyFirstProject",
"projectKey": "QsLA07Oa5sqTfwnNaFwS",
"tenantId": 1,
"platform": "web"
},
{
"projectId": 43,
"name": "MobileApp",
"projectKey": "9cACFRuQVidq0sqS7Bny",
"tenantId": 1,
"platform": "ios"
}
]
}
Ottenere un progetto
Section titled Ottenere un progettoRestituisce i dettagli del progetto specificato.
Metodo
Section titled MetodoGET
/public/projects/:projectKey
Parametri
Section titled Parametri| Nome | Tipo | Descrizione |
|---|---|---|
| projectKey | string | La chiave del progetto (obbligatoria) |
Header della richiesta
Section titled Header della richiestaAuthorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Codici di stato
Section titled Codici di stato200: restituito nel body
404: progetto non trovato
Esempio di richiesta
Section titled Esempio di richiestacurl -X GET \
{BASE_URL}/public/projects/7ePSXFuQVidq9pqS6Xyn \
-H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'
Esempio di risposta
Section titled Esempio di risposta{
"data": {
"projectId": 42,
"name": "MyFirstProject",
"projectKey": "7ePSXFuQVidq9pqS6Xyn",
"tenantId": 1,
"platform": "web"
}
}