Projets

Créer un projet

Créez un nouveau projet en spécifiant son name.

Méthode

POST

URL

/api/v1/projects

Paramètres

Nom	Type	Description
name	string	Le nom du projet que vous créez (par ex. MyApp, Production, Staging) (obligatoire)

En-têtes de la requête

Authorization: {YOUR_ORGANIZATION_API_KEY} : La clé se trouve dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Codes de statut

200 : Réponse envoyée au format JSON dans le corps

Exemple de requête

curl -X POST \
  https://openreplay.example.com/api/v1/projects/MyFirstProject \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'
  --data-raw '{
    "name": "MyFirstProject"
}'

Exemple de réponse

{
  "data": {
    "projectKey": "QsLA07Oa5sqTfwnNaFwS",
    "name": "MyFirstProject",
    "gdpr": {
      "maskEmails": true,
      "sampleRate": 50,
      "maskNumbers": true,
      "defaultInputMode": "plain"
    }
  }
}

Récupérer un projet

Renvoie les détails du projet spécifié.

Méthode

GET

URL

/api/v1/projects/:projectKey

Paramètres

Nom	Type	Description
projectKey	string	L’identifiant du projet que vous suivez (obligatoire)

En-têtes de la requête

Authorization: {YOUR_ORGANIZATION_API_KEY} : La clé se trouve dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Codes de statut

200 : Réponse envoyée au format JSON dans le corps

Exemple de requête

curl -X GET \
  https://openreplay.example.com/api/v1/projects/7ePSXFuQVidq9pqS6Xyn \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Exemple de réponse

{
  "data": {
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "name": "MyFirstProject"
  }
}

Récupérer les projets

Renvoie la liste des projets existants.

Méthode

GET

URL

/api/v1/projects

En-têtes de la requête

Authorization: {YOUR_ORGANIZATION_API_KEY} : La clé se trouve dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Codes de statut

200 : Réponse envoyée au format JSON dans le corps

Exemple de requête

curl -X GET \
  https://openreplay.example.com/api/v1/projects \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Exemple de réponse

{
  "data": {
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "name": "MyFirstProject"
  },
  {
    "projectKey": "9cACFRuQVidq0sqS7Bny",
    "name": "MySecondProject"
  }
}