Cloudflare API | RUM › Site Info › List Web Analytics Sites

API Reference

Overview

Account & User Management

Abuse Reports

Certificate Management

ACM

Certificate Authorities

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

SSL

Cloudflare One

Email Security

Zero Trust

DNS

Account Custom Nameservers

DNS

DNS Firewall

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Magic Transit

Network Interconnects

Observability

List Web Analytics sites

Get a Web Analytics site

Create a Web Analytics site

Update a Web Analytics site

Delete a Web Analytics site

Security Center

Radar

Routing & Performance

Rules

Security

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Workers & Pages

Workers For Platforms

Shared

RUM

rum

RUM

Rules

rum.rules

Methods

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.

Create A Web Analytics Rule -> Envelope<

RUMRule

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

Creates a new rule in a Web Analytics ruleset.

Update A Web Analytics Rule -> Envelope<

RUMRule

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

Updates a 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.

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.

Domain types

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

RUM

Site Info

rum.site_info

Methods

List Web Analytics Sites -> V4PagePaginationArray<

Site

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

Lists all Web Analytics sites of an account.

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 Read

path Parameters

account_id: string

(maxLength: 32)

Identifier.

query Parameters

order_by:

Optional

The property used to sort the list of results.

"host"

"created"

page: number

Optional

Current page within the paginated list of results.

per_page: number

Optional

Number of items to return per page of results.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: boolean

Whether the API call was successful.

result: Array<

Site

Optional

result_info: { count, page, per_page, 2 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rum/site_info/list \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

200Example

{
  "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 -> Envelope<

Site

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

Retrieves a Web Analytics site.

Create A Web Analytics Site -> Envelope<

Site

post/accounts/{account_id}/rum/site_info

Creates a new Web Analytics site.

Update A Web Analytics Site -> Envelope<

Site

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

Updates an existing Web Analytics site.

Delete A Web Analytics Site -> Envelope<{ site_tag }>

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

Deletes an existing Web Analytics site.

Domain types

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