Cloudflare API | RUM › Site Info › Create A Web Analytics Site

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Create a Web Analytics site

Delete a Web Analytics site

Get a Web Analytics site

List Web Analytics sites

Update a Web Analytics site

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

RUM

rum

Rules

rum.rules

Methods

Update Web Analytics Rules -> Envelope<{ rules, ruleset }>

post/accounts/{account_id}/rum/v2/{ruleset_id}/rules

Modifies one or more rules in a Web Analytics ruleset with a single request.

Create A Web Analytics Rule -> Envelope<

>

post/accounts/{account_id}/rum/v2/{ruleset_id}/rule

Creates a new rule in a Web Analytics ruleset.

Delete A Web Analytics Rule -> Envelope<{ id }>

delete/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}

Deletes an existing rule from a Web Analytics ruleset.

List Rules In Web Analytics Ruleset -> Envelope<{ rules, ruleset }>

get/accounts/{account_id}/rum/v2/{ruleset_id}/rules

Lists all the rules in a Web Analytics ruleset.

Update A Web Analytics Rule -> Envelope<

>

put/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}

Updates a rule in a Web Analytics ruleset.

Domain types

RUMRule = { id, created, host, 4 more... }

Site Info

rum.site_info

Methods

Create A Web Analytics Site -> Envelope<

>

post/accounts/{account_id}/rum/site_info

Creates a new Web Analytics site.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Account Settings Write

Parameters

account_id: string

(maxLength: 32)

Identifier

Response fields

errors: Array<

>

messages: Array<

>

success: boolean

Whether the API call was successful.

result:

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rum/site_info \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "auto_install": true,
      "host": "example.com",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "auto_install": true,
    "rules": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "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 -> Envelope<{ site_tag }>

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

Deletes an existing Web Analytics site.

Get A Web Analytics Site -> Envelope<

>

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

Retrieves a Web Analytics site.

List Web Analytics Sites -> V4PagePaginationArray<

>

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

Lists all Web Analytics sites of an account.

Update A Web Analytics Site -> Envelope<

>

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

Updates an existing Web Analytics site.

Domain types

Site = { auto_install, created, rules, 4 more... }