Проекты

Создание проекта

Создайте новый проект, указав его name.

Метод

POST

URL

/api/v1/projects

Параметры

Имя	Тип	Описание
name	string	Имя создаваемого проекта (например, MyApp, Production, Staging) (обязательно)

Заголовки запроса

Authorization: {YOUR_ORGANIZATION_API_KEY}: Ключ можно найти в разделе ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Коды состояния

200: Ответ отправлен в виде JSON в теле

Пример запроса

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"
}'

Пример ответа

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

Получение проекта

Возвращает данные указанного проекта.

Метод

GET

URL

/api/v1/projects/:projectKey

Параметры

Имя	Тип	Описание
projectKey	string	Идентификатор отслеживаемого проекта (обязательно)

Заголовки запроса

Authorization: {YOUR_ORGANIZATION_API_KEY}: Ключ можно найти в разделе ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Коды состояния

200: Ответ отправлен в виде JSON в теле

Пример запроса

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

Пример ответа

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

Получение проектов

Возвращает список существующих проектов.

Метод

GET

URL

/api/v1/projects

Заголовки запроса

Authorization: {YOUR_ORGANIZATION_API_KEY}: Ключ можно найти в разделе ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Коды состояния

200: Ответ отправлен в виде JSON в теле

Пример запроса

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

Пример ответа

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