Projects

Come creare e recuperare i progetti.

Projects

Tutte le risposte sono in formato JSON e racchiuse in { "data": ... }. Gli errori restituiscono { "error": "..." } con un codice di stato HTTP appropriato.

Crea un nuovo progetto specificandone il name e, facoltativamente, la platform.

POST

/public/projects

NomeTipoDescrizione
namestringIl nome del progetto (obbligatorio, max 200 caratteri)
platformstringPiattaforma del progetto: web (predefinita) o ios

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200: progetto creato, restituito nel body
400: body non valido, nome mancante o troppo lungo, piattaforma sconosciuta oppure nome già esistente

curl -X POST \
  {BASE_URL}/public/projects \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "name": "MyFirstProject",
    "platform": "web"
  }'
{
  "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
  }
}

Restituisce tutti i progetti del tenant corrente.

GET

/public/projects

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

curl -X GET \
  {BASE_URL}/public/projects \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'
{
  "data": [
    {
      "projectId": 42,
      "name": "MyFirstProject",
      "projectKey": "QsLA07Oa5sqTfwnNaFwS",
      "tenantId": 1,
      "platform": "web"
    },
    {
      "projectId": 43,
      "name": "MobileApp",
      "projectKey": "9cACFRuQVidq0sqS7Bny",
      "tenantId": 1,
      "platform": "ios"
    }
  ]
}

Restituisce i dettagli del progetto specificato.

GET

/public/projects/:projectKey

NomeTipoDescrizione
projectKeystringLa chiave del progetto (obbligatoria)

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200: restituito nel body
404: progetto non trovato

curl -X GET \
  {BASE_URL}/public/projects/7ePSXFuQVidq9pqS6Xyn \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'
{
  "data": {
    "projectId": 42,
    "name": "MyFirstProject",
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "tenantId": 1,
    "platform": "web"
  }
}