Projects

Create Project

Create a new project by specifying its name.

Method

POST

URL

/api/v1/projects

Parameters

Name	Type	Description
name	string	The name of the project you're creating (i.e. MyApp, Production, Staging) (required)

Request Headers

Authorization: {YOUR_ORGANIZATION_API_KEY}: The key can be found in 'Preferences' > 'Account' > 'Organization API Key'.

Status Codes

200: Response sent as JSON in body

Example Request

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

Example Response

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

Get Project

Returns the specified project's details.

Method

GET

URL

/api/v1/projects/:projectKey

Parameters

Name	Type	Description
projectKey	string	The ID of the project you're tracking (required)

Request Headers

Authorization: {YOUR_ORGANIZATION_API_KEY}: The key can be found in 'Preferences' > 'Account' > 'Organization API Key'.

Status Codes

200: Response sent as JSON in body

Example Request

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

Example Response

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

Get Projects

Returns the list of existing projects.

Method

GET

URL

/api/v1/projects

Request Headers

Authorization: {YOUR_ORGANIZATION_API_KEY}: The key can be found in 'Preferences' > 'Account' > 'Organization API Key'.

Status Codes

200: Response sent as JSON in body

Example Request

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

Example Response

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

Jobs

Sessions