Websites

Create a website

POST/api/websites

Creates a website with a name and domain, optionally assigning it to a team and creating a share.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Request body

Name	Type	Description
domainrequired	string	Domain name associated with the resource.
id	string \| null	Unique identifier of the resource.
namerequired	string	Display name of the resource.
shareId	string \| null	Identifier used to access a shared resource.
teamId	string \| null	ID of the associated team.

Example request

{
  "domain": "string",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "shareId": "string",
  "teamId": "123e4567-e89b-12d3-a456-426614174000"
}

Responses

200Website created.

Name	Type	Description
createdAtrequired	string \| null	Date and time the record was created.
createdByrequired	string \| null	ID of the user who created the resource.
deletedAtrequired	string \| null	Date and time the record was deleted, if applicable.
domainrequired	string \| null	Domain name associated with the resource.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
recorderEnabledrequired	boolean	Whether recording is enabled for the website.
replayConfigrequired	anyOf	Session replay and heatmap recording configuration.

resetAtrequired	string \| null	Date and time the website analytics were last reset.
shareIdrequired	string \| null	Identifier used to access a shared resource.
teamIdrequired	string \| null	ID of the associated team.
updatedAtrequired	string \| null	Date and time the record was last updated.
user	object

userIdrequired	string \| null	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "deletedAt": "2024-01-15T09:30:00Z",
  "domain": "string",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "recorderEnabled": true,
  "replayConfig": {
    "blockSelector": "string",
    "heatmapEnabled": true,
    "heatmapSampleRate": 0,
    "maskLevel": "strict",
    "maxDuration": 0,
    "replayEnabled": true,
    "sampleRate": 0
  },
  "resetAt": "2024-01-15T09:30:00Z",
  "shareId": "string",
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-01-15T09:30:00Z",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "string"
  },
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/websites' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain": "string",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "shareId": "string",
  "teamId": "123e4567-e89b-12d3-a456-426614174000"
}'

PreviousList websites NextGet a website