Skip to content

Ac 1385 domain allowlist #1607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 31, 2025
Merged

Ac 1385 domain allowlist #1607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b380347
AC-1385: allowed domains
lpmichalik Oct 28, 2025
228c1d6
visitor domains report
lpmichalik Oct 28, 2025
74683e6
Apply suggestions from code review
lpmichalik Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/pages/data-reporting/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ The developer preview version provides a preview of the upcoming changes to the

</Warning>

## [v3.7] - Developer Preview

### Stats

- There's a new method, [**Visitor Domains**](/data-reporting/reports-api/v3.7/#visitor-domains), which returns the top domains from which visitors accessed your website, along with their page view counts.

## [v3.6] - 2025-08-07

- There's a new method, [**Unique Visitors**](/data-reporting/reports-api/#unique-visitors), which returns the total number of page views and unique visitors during the specified period.
Expand Down
82 changes: 82 additions & 0 deletions src/pages/data-reporting/reports-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ You can authorize your calls to the Reports API using one of the following metho
| **Agents** | [`availability`](#availability) [`performance`](#performance) |
| **Customers** | [`unique_visitors`](#unique-visitors) [`queued_visitors`](#queued-visitors) [`queued_visitors_left`](#queued-visitors-left) |
| **Tags** | [`chat_usage`](#chat-usage) |
| **Stats** | [`visitor_domains`](#visitor-domains) |

## Available parameters and filters

Expand Down Expand Up @@ -1202,6 +1203,87 @@ https://api.livechatinc.com/v3.7/reports/tags/chat_usage \
</Code>
</Section>

## Stats

<Section>
<Text>

### Visitor Domains

Returns up to 100 domains from which visitors access your website, ranked by page view count.

#### Specifics

| | |
| ------------------- | ------------------------------------------------------------------ |
| **Method URL** | `https://api.livechatinc.com/v3.7/reports/stats/visitor_domains` |
| **HTTP method** | POST, GET |
| **Required scopes** | `reports_read` |

#### Request

| Parameter | Required | Data type | Notes |
| -------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------- |
| `filters` | No | `object` | If none provided, your report will span last seven days. |
| `filters.from` | No | `string` | Filters visits within specified time range. See [format reference](#available-parameters-and-filters). |
| `filters.to` | No | `string` | Filters visits within specified time range. See [format reference](#available-parameters-and-filters). |

#### Response

| Field | Notes |
| -------------------------- | ---------------------------------------------------------- |
| `name` | Report name: `visitor-domains-report`. |
| `summary` | Map of domain names with their page view counts. |
| `summary.<domain>` | Number of page views from the specified domain. |



</Text>
<Code>

<CodeSample path={'REQUEST'}>

<Sample>

```shell
curl -X POST \
https://api.livechatinc.com/v3.7/reports/stats/visitor_domains \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-d '{
"filters": {
"from": "2024-10-01T00:00:00-00:00",
"to": "2024-10-07T23:59:59-00:00"
}
}'
```

</Sample>
</CodeSample>

<CodeSample path={'RESPONSE'}>

<Sample>

```json
{
"name": "visitor-domains-report",
"summary": {
"example.com": 1523,
"another-site.org": 847,
"customer-portal.net": 612,
"shop.example.com": 458,
"blog.example.com": 234
}
}
```

</Sample>
</CodeSample>

</Code>
</Section>

# Contact us

If you found a bug or a typo, you can create an issue on [GitHub](https://github.com/livechat/livechat-public-docs/). In case of any questions or feedback, don't hesitate to contact us at [developers@text.com](mailto:developers@text.com)
7 changes: 7 additions & 0 deletions src/pages/management/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ The developer preview version provides a preview of the upcoming changes to the

## [v3.7] - Developer preview

### Allowed Domains

- Added allowed domains management methods:
- [**Add Allowed Domain**](/management/configuration-api/v3.7#add-allowed-domain)
- [**List Allowed Domains**](/management/configuration-api/v3.7#list-allowed-domains)
- [**Delete Allowed Domain**](/management/configuration-api/v3.7#delete-allowed-domain)

### Canned responses

- Added canned response management methods:
Expand Down
153 changes: 153 additions & 0 deletions src/pages/management/configuration-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ All configurations set by this API will have action in system after max 2 minute
| | |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Agents** | [`create_agent`](#create-agent) [`get_agent`](#get-agent) [`list_agents`](#list-agents) [`update_agent`](#update-agent) [`delete_agent`](#delete-agent) [`suspend_agent`](#suspend-agent) [`unsuspend_agent`](#unsuspend-agent) [`request_agent_unsuspension`](#request-agent-unsuspension) [`approve_agent`](#approve-agent) |
| **Allowed domains** | [`add_allowed_domain`](#add-allowed-domain) [`list_allowed_domains`](#list-allowed-domains) [`delete_allowed_domain`](#delete-allowed-domain) |
| **Auto access** | [`add_auto_access`](#add-auto-access) [`list_auto_access`](#list-auto-access) [`delete_auto_access`](#delete-auto-access) [`update_auto_access`](#update-auto-access) |
| **Bots** | [`create_bot_template`](#create-bot-template) [`create_bot`](#create-bot) [`delete_bot_template`](#delete-bot-template) [`delete_bot`](#delete-bot) [`update_bot_template`](#update-bot-template) [`update_bot`](#update-bot) [`list_bot_templates`](#list-bot-templates) [`get_bot`](#get-bot) [`list_bots`](#list-bots) [`issue_bot_token`](#issue-bot-token) [`reset_bot_template_secret`](#reset-bot-template-secret) [`reset_bot_secret`](#reset-bot-secret) |
| **Customer bans** | [`list_customer_bans`](#list-customer-bans) [`unban_customer`](#unban-customer) |
Expand Down Expand Up @@ -836,6 +837,158 @@ curl -X POST \

</Section>

# Allowed domains

**Allowed domains** is a security feature that enables you to restrict which domains can embed your chat widget. By configuring allowed domains, you can prevent unauthorized websites from using your LiveChat license. Only domains explicitly added to the allowed list will be able to display and use your chat widget.

## Methods

<Section>

<Text>

### Add Allowed Domain

Adds a new domain to the allowed domains list.

#### Specifics

| | |
| -------------------------------- | ---------------------------------------------------------------------------- |
| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/add_allowed_domain` |
| Required scopes | `domain_manage` |
| [Batch support](#batch-requests) | No |

| Parameter | Required | Data type | Notes |
| --------- | -------- | --------- | ------------------------------------------------- |
| `domain` | Yes | `string` | Domain name (max 255 characters) |

</Text>

<Code>

<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.7/configuration/action/add_allowed_domain \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-d '{
"domain": "example.com"
}'
```

</CodeSample>

<CodeResponse>

```json
{}
```

</CodeResponse>

</Code>

</Section>

<Section>

<Text>

### List Allowed Domains

Returns all domains currently allowed to embed your chat widget.

#### Specifics

| | |
| -------------------------------- | ------------------------------------------------------------------------------ |
| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/list_allowed_domains` |
| Required scopes | `domain_manage` |
| [Batch support](#batch-requests) | No |

</Text>

<Code>

<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.7/configuration/action/list_allowed_domains \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-d '{}'
```

</CodeSample>

<CodeResponse>

```json
{
"domains": [
"example.com",
"subdomain.example.com",
"another-domain.com"
]
}
```

</CodeResponse>

</Code>

</Section>

<Section>

<Text>

### Delete Allowed Domain

Removes a domain from the allowed domains list.

#### Specifics

| | |
| -------------------------------- | ------------------------------------------------------------------------------- |
| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/delete_allowed_domain` |
| Required scopes | `domain_manage` |
| [Batch support](#batch-requests) | No |

| Parameter | Required | Data type | Notes |
| --------- | -------- | --------- | -------------------------------- |
| `domain` | Yes | `string` | Domain name |

#### Response

No response payload (`200 OK`).

</Text>

<Code>

<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.7/configuration/action/delete_allowed_domain \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-d '{
"domain": "example.com"
}'
```

</CodeSample>

</Code>

</Section>

# Auto access

**Auto access** allows you to assign groups to a thread that will be created when a customer starts a chat. Those groups are
Expand Down