This API exposes
10 operations
across 6 paths,
and defines 29 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
10 operations6 paths29 schemas2 DELETE3 GET3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Web Analytics API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 10
Across 6 paths, the API surfaces 10 operations — 2 DELETE, 3 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Web Analytics 10
POST
/accounts/{account_id}/rum/site_info
APIs.io Engineering Platform Create a Web Analytics site
web-analytics-create-site1 parambody→ 4XX200
DELETE
/accounts/{account_id}/rum/site_info/{site_id}
APIs.io Engineering Platform Delete a Web Analytics site
web-analytics-delete-site2 params→ 4XX200
GET
/accounts/{account_id}/rum/site_info/{site_id}
APIs.io Engineering Platform Get a Web Analytics site
web-analytics-get-site2 params→ 4XX200
PUT
/accounts/{account_id}/rum/site_info/{site_id}
APIs.io Engineering Platform Update a Web Analytics site
web-analytics-update-site2 paramsbody→ 4XX200
GET
/accounts/{account_id}/rum/site_info/list
APIs.io Engineering Platform List Web Analytics sites
web-analytics-list-sites4 params→ 4XX200
POST
/accounts/{account_id}/rum/v2/{ruleset_id}/rule
APIs.io Engineering Platform Create a Web Analytics rule
APIs.io Engineering Platform Update a Web Analytics rule
web-analytics-update-rule3 paramsbody→ 4XX200
GET
/accounts/{account_id}/rum/v2/{ruleset_id}/rules
APIs.io Engineering Platform List rules in Web Analytics ruleset
web-analytics-list-rules2 params→ 4XX200
POST
/accounts/{account_id}/rum/v2/{ruleset_id}/rules
APIs.io Engineering Platform Update Web Analytics rules
web-analytics-modify-rules2 paramsbody→ 4XX200
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are rum_rule (7 properties), rum_site (7 properties), rum_result_info (5 properties), rum_ruleset (4 properties). Each schema is shown below with its type and property counts.
rum_zone_tag
string
The zone identifier.
rum_ruleset
object
4 properties
rum_create-rule-request
object
4 properties
rum_rules-response-collection
rum_rules
array
A list of rules.
rum_modify-rules-request
object
2 properties
rum_timestamp
string
rum_site-tag-response-single
rum_page
number
Current page within the paginated list of results.
rum_create-site-request
object
3 properties
rum_rule-id-response-single
rum_snippet
string
Encoded JavaScript snippet.
rum_site_token
string
The Web Analytics site token.
rum_rule-response-single
rum_messages
array
rum_api-response-common
object
3 properties3 required
rum_site-response-single
rum_site
object
7 properties
rum_identifier
string
Identifier
rum_api-response-common-failure
object
4 properties4 required
rum_per_page
number
Number of items to return per page of results.
rum_rule
object
7 properties
rum_auto_install
boolean
If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
rum_site_tag
string
The Web Analytics site identifier.
rum_order_by
string
The property used to sort the list of results.
rum_sites-response-collection
rum_ruleset_identifier
string
The Web Analytics ruleset identifier.
rum_result_info
object
5 properties
rum_rule_identifier
string
The Web Analytics rule identifier.
Specification
The full machine-readable OpenAPI contract behind this narrative.
