site_info

Creates, updates, deletes, gets or lists a site_info resource.

Overview

Name	site_info
Type	Resource
Id	cloudflare.rum.site_info

Fields

The following fields are returned by SELECT queries:

get

Web Analytics site.

Name	Datatype	Description
auto_install	boolean	If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
created	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
rules	array	A list of rules.
ruleset	object
site_tag	string	The Web Analytics site identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
site_token	string	The Web Analytics site token. (example: 023e105f4ecef8ad9ca31a8372d0c353)
snippet	string	Encoded JavaScript snippet. (example: <!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "bc40a2d1b5834453aba85c1b9a3054da"}'></script><!-- End Cloudflare Web Analytics -->)

list

List of Web Analytics sites.

Name	Datatype	Description
auto_install	boolean	If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
created	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
rules	array	A list of rules.
ruleset	object
site_tag	string	The Web Analytics site identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
site_token	string	The Web Analytics site token. (example: 023e105f4ecef8ad9ca31a8372d0c353)
snippet	string	Encoded JavaScript snippet. (example: <!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "bc40a2d1b5834453aba85c1b9a3054da"}'></script><!-- End Cloudflare Web Analytics -->)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, site_id		Retrieves a Web Analytics site.
list	select	account_id	per_page, page, order_by	Lists all Web Analytics sites of an account.
create	insert	account_id		Creates a new Web Analytics site.
update	replace	account_id, site_id		Updates an existing Web Analytics site.
delete	delete	account_id, site_id		Deletes an existing Web Analytics site.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
site_id	string	The site ID.
order_by	string
page	number
per_page	number

SELECT examples

get

Retrieves a Web Analytics site.

SELECT
auto_install,
created,
rules,
ruleset,
site_tag,
site_token,
snippet
FROM cloudflare.rum.site_info
WHERE account_id = '{{ account_id }}' -- required
AND site_id = '{{ site_id }}' -- required
;

list

Lists all Web Analytics sites of an account.

SELECT
auto_install,
created,
rules,
ruleset,
site_tag,
site_token,
snippet
FROM cloudflare.rum.site_info
WHERE account_id = '{{ account_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
AND order_by = '{{ order_by }}'
;

INSERT examples

create

Creates a new Web Analytics site.

INSERT INTO cloudflare.rum.site_info (
auto_install,
host,
zone_tag,
account_id
)
SELECT 
{{ auto_install }},
'{{ host }}',
'{{ zone_tag }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: site_info
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the site_info resource.
  - name: auto_install
    value: {{ auto_install }}
    description: |
      If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
  - name: host
    value: "{{ host }}"
    description: |
      The hostname to use for gray-clouded sites.
  - name: zone_tag
    value: "{{ zone_tag }}"
    description: |
      The zone identifier.

REPLACE examples

update

Updates an existing Web Analytics site.

REPLACE cloudflare.rum.site_info
SET 
auto_install = {{ auto_install }},
enabled = {{ enabled }},
host = '{{ host }}',
lite = {{ lite }},
zone_tag = '{{ zone_tag }}'
WHERE 
account_id = '{{ account_id }}' --required
AND site_id = '{{ site_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes an existing Web Analytics site.

DELETE FROM cloudflare.rum.site_info
WHERE account_id = '{{ account_id }}' --required
AND site_id = '{{ site_id }}' --required
;