# Site Info

## List Web Analytics sites

`rum.site_info.list(SiteInfoListParams**kwargs)  -> SyncV4PagePaginationArray[Site]`

**get** `/accounts/{account_id}/rum/site_info/list`

Lists all Web Analytics sites of an account.

### Parameters

- `account_id: str`

  Identifier.

- `order_by: Optional[Literal["host", "created"]]`

  The property used to sort the list of results.

  - `"host"`

  - `"created"`

- `page: Optional[float]`

  Current page within the paginated list of results.

- `per_page: Optional[float]`

  Number of items to return per page of results.

### Returns

- `class Site: …`

  - `auto_install: Optional[bool]`

    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

  - `created: Optional[datetime]`

  - `rules: Optional[List[RUMRule]]`

    A list of rules.

    - `id: Optional[str]`

      The Web Analytics rule identifier.

    - `created: Optional[datetime]`

    - `host: Optional[str]`

      The hostname the rule will be applied to.

    - `inclusive: Optional[bool]`

      Whether the rule includes or excludes traffic from being measured.

    - `is_paused: Optional[bool]`

      Whether the rule is paused or not.

    - `paths: Optional[List[str]]`

      The paths the rule will be applied to.

    - `priority: Optional[float]`

  - `ruleset: Optional[Ruleset]`

    - `id: Optional[str]`

      The Web Analytics ruleset identifier.

    - `enabled: Optional[bool]`

      Whether the ruleset is enabled.

    - `zone_name: Optional[str]`

    - `zone_tag: Optional[str]`

      The zone identifier.

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.

  - `site_token: Optional[str]`

    The Web Analytics site token.

  - `snippet: Optional[str]`

    Encoded JavaScript snippet.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.rum.site_info.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.auto_install)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "auto_install": true,
      "created": "2014-01-01T05:20:00.12345Z",
      "rules": [
        {
          "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
          "created": "2014-01-01T05:20:00.12345Z",
          "host": "example.com",
          "inclusive": true,
          "is_paused": false,
          "paths": [
            "*"
          ],
          "priority": 1000
        }
      ],
      "ruleset": {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "enabled": true,
        "zone_name": "example.com",
        "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
      },
      "site_tag": "023e105f4ecef8ad9ca31a8372d0c353",
      "site_token": "023e105f4ecef8ad9ca31a8372d0c353",
      "snippet": "<!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{\"token\": \"bc40a2d1b5834453aba85c1b9a3054da\"}'></script><!-- End Cloudflare Web Analytics -->"
    }
  ],
  "result_info": {
    "count": 10,
    "page": 1,
    "per_page": 10,
    "total_count": 25,
    "total_pages": 3
  }
}
```

## Get a Web Analytics site

`rum.site_info.get(strsite_id, SiteInfoGetParams**kwargs)  -> Site`

**get** `/accounts/{account_id}/rum/site_info/{site_id}`

Retrieves a Web Analytics site.

### Parameters

- `account_id: str`

  Identifier.

- `site_id: str`

  Identifier.

### Returns

- `class Site: …`

  - `auto_install: Optional[bool]`

    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

  - `created: Optional[datetime]`

  - `rules: Optional[List[RUMRule]]`

    A list of rules.

    - `id: Optional[str]`

      The Web Analytics rule identifier.

    - `created: Optional[datetime]`

    - `host: Optional[str]`

      The hostname the rule will be applied to.

    - `inclusive: Optional[bool]`

      Whether the rule includes or excludes traffic from being measured.

    - `is_paused: Optional[bool]`

      Whether the rule is paused or not.

    - `paths: Optional[List[str]]`

      The paths the rule will be applied to.

    - `priority: Optional[float]`

  - `ruleset: Optional[Ruleset]`

    - `id: Optional[str]`

      The Web Analytics ruleset identifier.

    - `enabled: Optional[bool]`

      Whether the ruleset is enabled.

    - `zone_name: Optional[str]`

    - `zone_tag: Optional[str]`

      The zone identifier.

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.

  - `site_token: Optional[str]`

    The Web Analytics site token.

  - `snippet: Optional[str]`

    Encoded JavaScript snippet.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
site = client.rum.site_info.get(
    site_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(site.auto_install)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "auto_install": true,
    "created": "2014-01-01T05:20:00.12345Z",
    "rules": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "created": "2014-01-01T05:20:00.12345Z",
        "host": "example.com",
        "inclusive": true,
        "is_paused": false,
        "paths": [
          "*"
        ],
        "priority": 1000
      }
    ],
    "ruleset": {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "enabled": true,
      "zone_name": "example.com",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
    },
    "site_tag": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_token": "023e105f4ecef8ad9ca31a8372d0c353",
    "snippet": "<!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{\"token\": \"bc40a2d1b5834453aba85c1b9a3054da\"}'></script><!-- End Cloudflare Web Analytics -->"
  }
}
```

## Create a Web Analytics site

`rum.site_info.create(SiteInfoCreateParams**kwargs)  -> Site`

**post** `/accounts/{account_id}/rum/site_info`

Creates a new Web Analytics site.

### Parameters

- `account_id: str`

  Identifier.

- `auto_install: Optional[bool]`

  If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

- `host: Optional[str]`

  The hostname to use for gray-clouded sites.

- `zone_tag: Optional[str]`

  The zone identifier.

### Returns

- `class Site: …`

  - `auto_install: Optional[bool]`

    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

  - `created: Optional[datetime]`

  - `rules: Optional[List[RUMRule]]`

    A list of rules.

    - `id: Optional[str]`

      The Web Analytics rule identifier.

    - `created: Optional[datetime]`

    - `host: Optional[str]`

      The hostname the rule will be applied to.

    - `inclusive: Optional[bool]`

      Whether the rule includes or excludes traffic from being measured.

    - `is_paused: Optional[bool]`

      Whether the rule is paused or not.

    - `paths: Optional[List[str]]`

      The paths the rule will be applied to.

    - `priority: Optional[float]`

  - `ruleset: Optional[Ruleset]`

    - `id: Optional[str]`

      The Web Analytics ruleset identifier.

    - `enabled: Optional[bool]`

      Whether the ruleset is enabled.

    - `zone_name: Optional[str]`

    - `zone_tag: Optional[str]`

      The zone identifier.

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.

  - `site_token: Optional[str]`

    The Web Analytics site token.

  - `snippet: Optional[str]`

    Encoded JavaScript snippet.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
site = client.rum.site_info.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(site.auto_install)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "auto_install": true,
    "created": "2014-01-01T05:20:00.12345Z",
    "rules": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "created": "2014-01-01T05:20:00.12345Z",
        "host": "example.com",
        "inclusive": true,
        "is_paused": false,
        "paths": [
          "*"
        ],
        "priority": 1000
      }
    ],
    "ruleset": {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "enabled": true,
      "zone_name": "example.com",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
    },
    "site_tag": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_token": "023e105f4ecef8ad9ca31a8372d0c353",
    "snippet": "<!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{\"token\": \"bc40a2d1b5834453aba85c1b9a3054da\"}'></script><!-- End Cloudflare Web Analytics -->"
  }
}
```

## Update a Web Analytics site

`rum.site_info.update(strsite_id, SiteInfoUpdateParams**kwargs)  -> Site`

**put** `/accounts/{account_id}/rum/site_info/{site_id}`

Updates an existing Web Analytics site.

### Parameters

- `account_id: str`

  Identifier.

- `site_id: str`

  Identifier.

- `auto_install: Optional[bool]`

  If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

- `enabled: Optional[bool]`

  Enables or disables RUM. This option can be used only when auto_install is set to true.

- `host: Optional[str]`

  The hostname to use for gray-clouded sites.

- `lite: Optional[bool]`

  If enabled, the JavaScript snippet will not be injected for visitors from the EU.

- `zone_tag: Optional[str]`

  The zone identifier.

### Returns

- `class Site: …`

  - `auto_install: Optional[bool]`

    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

  - `created: Optional[datetime]`

  - `rules: Optional[List[RUMRule]]`

    A list of rules.

    - `id: Optional[str]`

      The Web Analytics rule identifier.

    - `created: Optional[datetime]`

    - `host: Optional[str]`

      The hostname the rule will be applied to.

    - `inclusive: Optional[bool]`

      Whether the rule includes or excludes traffic from being measured.

    - `is_paused: Optional[bool]`

      Whether the rule is paused or not.

    - `paths: Optional[List[str]]`

      The paths the rule will be applied to.

    - `priority: Optional[float]`

  - `ruleset: Optional[Ruleset]`

    - `id: Optional[str]`

      The Web Analytics ruleset identifier.

    - `enabled: Optional[bool]`

      Whether the ruleset is enabled.

    - `zone_name: Optional[str]`

    - `zone_tag: Optional[str]`

      The zone identifier.

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.

  - `site_token: Optional[str]`

    The Web Analytics site token.

  - `snippet: Optional[str]`

    Encoded JavaScript snippet.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
site = client.rum.site_info.update(
    site_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(site.auto_install)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "auto_install": true,
    "created": "2014-01-01T05:20:00.12345Z",
    "rules": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "created": "2014-01-01T05:20:00.12345Z",
        "host": "example.com",
        "inclusive": true,
        "is_paused": false,
        "paths": [
          "*"
        ],
        "priority": 1000
      }
    ],
    "ruleset": {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "enabled": true,
      "zone_name": "example.com",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
    },
    "site_tag": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_token": "023e105f4ecef8ad9ca31a8372d0c353",
    "snippet": "<!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{\"token\": \"bc40a2d1b5834453aba85c1b9a3054da\"}'></script><!-- End Cloudflare Web Analytics -->"
  }
}
```

## Delete a Web Analytics site

`rum.site_info.delete(strsite_id, SiteInfoDeleteParams**kwargs)  -> SiteInfoDeleteResponse`

**delete** `/accounts/{account_id}/rum/site_info/{site_id}`

Deletes an existing Web Analytics site.

### Parameters

- `account_id: str`

  Identifier.

- `site_id: str`

  Identifier.

### Returns

- `class SiteInfoDeleteResponse: …`

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
site_info = client.rum.site_info.delete(
    site_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(site_info.site_tag)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "site_tag": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}
```

## Domain Types

### Site

- `class Site: …`

  - `auto_install: Optional[bool]`

    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

  - `created: Optional[datetime]`

  - `rules: Optional[List[RUMRule]]`

    A list of rules.

    - `id: Optional[str]`

      The Web Analytics rule identifier.

    - `created: Optional[datetime]`

    - `host: Optional[str]`

      The hostname the rule will be applied to.

    - `inclusive: Optional[bool]`

      Whether the rule includes or excludes traffic from being measured.

    - `is_paused: Optional[bool]`

      Whether the rule is paused or not.

    - `paths: Optional[List[str]]`

      The paths the rule will be applied to.

    - `priority: Optional[float]`

  - `ruleset: Optional[Ruleset]`

    - `id: Optional[str]`

      The Web Analytics ruleset identifier.

    - `enabled: Optional[bool]`

      Whether the ruleset is enabled.

    - `zone_name: Optional[str]`

    - `zone_tag: Optional[str]`

      The zone identifier.

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.

  - `site_token: Optional[str]`

    The Web Analytics site token.

  - `snippet: Optional[str]`

    Encoded JavaScript snippet.

### Site Info Delete Response

- `class SiteInfoDeleteResponse: …`

  - `site_tag: Optional[str]`

    The Web Analytics site identifier.