项目

创建项目

通过指定 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	你正在跟踪的项目的 ID（必填）

请求头

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