APIs.io Engineering Platform Web Analytics API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Web Analytics API
  version: 4.0.0
tags:
- name: Web Analytics
paths:
  /accounts/{account_id}/rum/site_info:
    post:
      description: Creates a new Web Analytics site.
      operationId: web-analytics-create-site
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-site-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-response-single'
          description: Created Web Analytics site
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create a Web Analytics site
      tags:
      - Web Analytics
      x-api-token-group:
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/site_info/{site_id}:
    delete:
      description: Deletes an existing Web Analytics site.
      operationId: web-analytics-delete-site
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-tag-response-single'
          description: Deleted Web Analytics site identifier
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete a Web Analytics site
      tags:
      - Web Analytics
      x-api-token-group:
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Retrieves a Web Analytics site.
      operationId: web-analytics-get-site
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-response-single'
          description: Web Analytics site
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get a Web Analytics site
      tags:
      - Web Analytics
      x-api-token-group:
      - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates an existing Web Analytics site.
      operationId: web-analytics-update-site
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-site-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-response-single'
          description: Updated Web Analytics site
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update a Web Analytics site
      tags:
      - Web Analytics
      x-api-token-group:
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/site_info/list:
    get:
      description: Lists all Web Analytics sites of an account.
      operationId: web-analytics-list-sites
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: query
        name: per_page
        schema:
          $ref: '#/components/schemas/rum_per_page'
      - in: query
        name: page
        schema:
          $ref: '#/components/schemas/rum_page'
      - in: query
        name: order_by
        schema:
          $ref: '#/components/schemas/rum_order_by'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_sites-response-collection'
          description: List of Web Analytics sites
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Web Analytics sites
      tags:
      - Web Analytics
      x-api-token-group:
      - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/v2/{ruleset_id}/rule:
    post:
      description: Creates a new rule in a Web Analytics ruleset.
      operationId: web-analytics-create-rule
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_ruleset_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-rule-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rule-response-single'
          description: Created Web Analytics rule
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create a Web Analytics rule
      tags:
      - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}:
    delete:
      description: Deletes an existing rule from a Web Analytics ruleset.
      operationId: web-analytics-delete-rule
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_ruleset_identifier'
      - in: path
        name: rule_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_rule_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rule-id-response-single'
          description: Deleted Web Analytics rule identifier
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete a Web Analytics rule
      tags:
      - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    put:
      description: Updates a rule in a Web Analytics ruleset.
      operationId: web-analytics-update-rule
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_ruleset_identifier'
      - in: path
        name: rule_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_rule_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-rule-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rule-response-single'
          description: Updated Web Analytics rule
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update a Web Analytics rule
      tags:
      - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/rum/v2/{ruleset_id}/rules:
    get:
      description: Lists all the rules in a Web Analytics ruleset.
      operationId: web-analytics-list-rules
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_ruleset_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rules-response-collection'
          description: List of Web Analytics rules in the ruleset
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List rules in Web Analytics ruleset
      tags:
      - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Modifies one or more rules in a Web Analytics ruleset with a single request.
      operationId: web-analytics-modify-rules
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_identifier'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rum_ruleset_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_modify-rules-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rules-response-collection'
          description: List of modified Web Analytics rules
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Web Analytics rules
      tags:
      - Web Analytics
      x-api-token-group:
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
components:
  schemas:
    rum_snippet:
      description: 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 -->'
      type: string
    rum_result_info:
      properties:
        count:
          description: The total number of items on the current page.
          example: 10
          type: integer
        page:
          description: Current page within the paginated list of results.
          example: 1
          type: integer
        per_page:
          description: The maximum number of items to return per page of results.
          example: 10
          type: integer
        total_count:
          description: The total number of items.
          example: 25
          type: integer
        total_pages:
          description: The total number of pages.
          example: 3
          type:
          - integer
          - 'null'
      type: object
    rum_per_page:
      description: Number of items to return per page of results.
      example: 10
      type: number
    rum_rules-response-collection:
      allOf:
      - $ref: '#/components/schemas/rum_api-response-common'
      - properties:
          result:
            properties:
              rules:
                $ref: '#/components/schemas/rum_rules'
              ruleset:
                $ref: '#/components/schemas/rum_ruleset'
            type: object
    rum_site:
      properties:
        auto_install:
          $ref: '#/components/schemas/rum_auto_install'
        created:
          $ref: '#/components/schemas/rum_timestamp'
        rules:
          $ref: '#/components/schemas/rum_rules'
        ruleset:
          $ref: '#/components/schemas/rum_ruleset'
        site_tag:
          $ref: '#/components/schemas/rum_site_tag'
        site_token:
          $ref: '#/components/schemas/rum_site_token'
        snippet:
          $ref: '#/components/schemas/rum_snippet'
      type: object
    rum_site_tag:
      description: The Web Analytics site identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      type: string
    rum_create-site-request:
      properties:
        auto_install:
          $ref: '#/components/schemas/rum_auto_install'
        host:
          description: The hostname to use for gray-clouded sites.
          example: example.com
          type: string
        zone_tag:
          $ref: '#/components/schemas/rum_zone_tag'
      type: object
    rum_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/rum_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/rum_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    rum_rule-id-response-single:
      allOf:
      - $ref: '#/components/schemas/rum_api-response-common'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/rum_rule_identifier'
            type: object
    rum_site-response-single:
      allOf:
      - $ref: '#/components/schemas/rum_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/rum_site'
    rum_rule-response-single:
      allOf:
      - $ref: '#/components/schemas/rum_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/rum_rule'
    rum_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/rum_messages'
        messages:
          $ref: '#/components/schemas/rum_messages'
        success:
          description: Whether the API call was successful.
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    rum_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      readOnly: true
      type: string
    rum_rules:
      description: A list of rules.
      items:
        $ref: '#/components/schemas/rum_rule'
      type: array
    rum_rule:
      properties:
        created:
          $ref: '#/components/schemas/rum_timestamp'
        host:
          description: The hostname the rule will be applied to.
          example: example.com
          type: string
        id:
          $ref: '#/components/schemas/rum_rule_identifier'
        inclusive:
          description: Whether the rule includes or excludes traffic from being measured.
          example: true
          type: boolean
        is_paused:
          description: Whether the rule is paused or not.
          example: false
          type: boolean
        paths:
          description: The paths the rule will be applied to.
          example:
          - '*'
          items:
            type: string
          type: array
        priority:
          example: 1000
          type: number
      type: object
    rum_order_by:
      description: The property used to sort the list of results.
      enum:
      - host
      - created
      example: host
      type: string
    rum_site-tag-response-single:
      allOf:
      - $ref: '#/components/schemas/rum_api-response-common'
      - properties:
          result:
            properties:
              site_tag:
                $ref: '#/components/schemas/rum_site_tag'
            type: object
    rum_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    rum_ruleset_identifier:
      description: The Web Analytics ruleset identifier.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      type: string
    rum_ruleset:
      properties:
        enabled:
          description: Whether the ruleset is enabled.
          example: true
          type: boolean
        id:
          $ref: '#/components/schemas/rum_ruleset_identifier'
        zone_name:
          example: example.com
          type: string
        zone_tag:
          $ref: '#/components/schemas/rum_zone_tag'
      type: object
    rum_page:
      description: Current page within the paginated list of results.
      example: 1
      type: number
    rum_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    rum_create-rule-request:
      properties:
        host:
          example: example.com
          type: string
        inclusive:
          description: Whether the rule includes or excludes traffic from being measured.
          example: true
          type: boolean
        is_paused:
          description: Whether the rule is paused or not.
          example: false
          type: boolean
        paths:
          example:
          - '*'
          items:
            type: string
          type: array
      type: object
    rum_site_token:
      description: The Web Analytics site token.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      type: string
    rum_zone_tag:
      description: The zone identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      type: string
    rum_rule_identifier:
      description: The Web Analytics rule identifier.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      type: string
    rum_modify-rules-request:
      properties:
        delete_rules:
          description: A list of rule identifiers to delete.
          items:
            $ref: '#/components/schemas/rum_rule_identifier'
          type: array
        rules:
          description: A list of rules to create or update.
          items:
            properties:
              host:
                example: example.com
                type: string
              id:
                $ref: '#/components/schemas/rum_rule_identifier'
              inclusive:
                example: true
                type: boolean
              is_paused:
                example: false
                type: boolean
              paths:
                example:
                - '*'
                items:
                  type: string
                type: array
            type: object
          type: array
      type: object
    rum_sites-response-collection:
      allOf:
      - $ref: '#/components/schemas/rum_api-response-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/rum_site'
            type: array
          result_info:
            $ref: '#/components/schemas/rum_result_info'
    rum_auto_install:
      description: If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
      example: true
      type: boolean
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey