Projets
Toutes les réponses sont au format JSON et encapsulées dans { "data": ... }. Les erreurs renvoient { "error": "..." } avec un code de statut HTTP approprié.
Créer un projet
Section titled Créer un projetCréez un nouveau projet en spécifiant son name et, éventuellement, sa platform.
Méthode
Section titled MéthodePOST
/public/projects
Payload
Section titled Payload| Nom | Type | Description |
|---|---|---|
| name | string | Le nom du projet (obligatoire, 200 caractères max.) |
| platform | string | Plateforme du projet : web (par défaut) ou ios |
En-têtes de la requête
Section titled En-têtes de la requêteAuthorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Codes de statut
Section titled Codes de statut200 : Projet créé, renvoyé dans le corps
400 : Corps invalide, nom manquant/trop long, plateforme inconnue ou nom déjà existant
Exemple de requête
Section titled Exemple de requêtecurl -X POST \
{BASE_URL}/public/projects \
-H 'content-type: application/json' \
-H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
--data-raw '{
"name": "MyFirstProject",
"platform": "web"
}'
Exemple de réponse
Section titled Exemple de réponse{
"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
}
}
Lister les projets
Section titled Lister les projetsRenvoie tous les projets du tenant actuel.
Méthode
Section titled MéthodeGET
/public/projects
En-têtes de la requête
Section titled En-têtes de la requêteAuthorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Exemple de requête
Section titled Exemple de requêtecurl -X GET \
{BASE_URL}/public/projects \
-H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'
Exemple de réponse
Section titled Exemple de réponse{
"data": [
{
"projectId": 42,
"name": "MyFirstProject",
"projectKey": "QsLA07Oa5sqTfwnNaFwS",
"tenantId": 1,
"platform": "web"
},
{
"projectId": 43,
"name": "MobileApp",
"projectKey": "9cACFRuQVidq0sqS7Bny",
"tenantId": 1,
"platform": "ios"
}
]
}
Obtenir un projet
Section titled Obtenir un projetRenvoie les détails du projet spécifié.
Méthode
Section titled MéthodeGET
/public/projects/:projectKey
Paramètres
Section titled Paramètres| Nom | Type | Description |
|---|---|---|
| projectKey | string | La clé du projet (obligatoire) |
En-têtes de la requête
Section titled En-têtes de la requêteAuthorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Codes de statut
Section titled Codes de statut200 : Renvoyé dans le corps
404 : Projet introuvable
Exemple de requête
Section titled Exemple de requêtecurl -X GET \
{BASE_URL}/public/projects/7ePSXFuQVidq9pqS6Xyn \
-H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'
Exemple de réponse
Section titled Exemple de réponse{
"data": {
"projectId": 42,
"name": "MyFirstProject",
"projectKey": "7ePSXFuQVidq9pqS6Xyn",
"tenantId": 1,
"platform": "web"
}
}