Session Replay Settings API

Configure session replay capture. Create, list, update, and delete session replay settings in your Ours Privacy account.

Configure session replay settings. Create, list, update, and delete replay settings in your account.

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

limit?|

Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100.

cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/replay-settings"

{
  "entities": [
    {
      "id": "string",
      "name": "string",
      "status": "Disabled",
      "createdAt": "string",
      "updatedAt": "string",
      "whitelistDomains": [
        "string"
      ],
      "customDomain": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customDomain?|

Optional custom domain (CNAME) for hosting the replay capture script. Leave null to use the default Ours Privacy domain.

name?|

Human-readable label for this replay configuration. Shown in the dashboard. May be empty.

status?|

Whether session replay capture is currently active. Set to "Enabled" to start capturing replays from whitelisted domains, or "Disabled" to pause capture without losing the configuration.

Value in"Disabled" | "Enabled"

whitelistDomains?array<>|

Hostnames where session replay capture is permitted. Replays initiated from any host not in this list are dropped. PATCH replaces the list — partial updates are not merged.

Response Body

`application/json`

curl -X POST "https://app.oursprivacy.com/rest/v1/replay-settings" \  -H "Content-Type: application/json" \  -d '{}'

{
  "isSuccess": true,
  "cause": "string",
  "replaySettings": {}
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/replay-settings/string"

{
  "id": "string",
  "name": "string",
  "status": "Disabled",
  "createdAt": "string",
  "updatedAt": "string",
  "whitelistDomains": [
    "string"
  ],
  "customDomain": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customDomain?|

Optional custom domain (CNAME) for hosting the replay capture script. Leave null to use the default Ours Privacy domain.

name?|

Human-readable label for this replay configuration. Shown in the dashboard. May be empty.

status?|

Whether session replay capture is currently active. Set to "Enabled" to start capturing replays from whitelisted domains, or "Disabled" to pause capture without losing the configuration.

Value in"Disabled" | "Enabled"

whitelistDomains?array<>|

Hostnames where session replay capture is permitted. Replays initiated from any host not in this list are dropped. PATCH replaces the list — partial updates are not merged.

Response Body

`application/json`

curl -X PATCH "https://app.oursprivacy.com/rest/v1/replay-settings/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "isSuccess": true,
  "cause": "string",
  "replaySettings": {}
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://app.oursprivacy.com/rest/v1/replay-settings/string"

{
  "isSuccess": true,
  "cause": "string",
  "replaySettings": {}
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Session Replay Settings

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`