> ## Documentation Index
> Fetch the complete documentation index at: https://developers.aptranet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get traffic data

> Project-scoped operation. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields.



## OpenAPI

````yaml /openapi-shield.json get /shield/analytics/traffic
openapi: 3.1.0
info:
  title: Aptranet Cloud Shield API
  version: 1.0.0
  description: >-
    Public project-scoped API. Use the access key and secret together.
    Browser-only organization administration is documented separately. Request
    schemas and query parameters follow the service operation allowlist. Plan
    entitlements apply in addition to API permissions. Some analytics and action
    responses have operation-specific JSON shapes; where the implementation
    provides no stable response contract, the reference deliberately does not
    invent one.
servers:
  - url: https://api.aptranet.com
security:
  - bearerAuth: []
    apiSecret: []
paths:
  /shield/analytics/traffic:
    get:
      tags:
        - Cloud Shield Analytics
      summary: Get traffic data
      description: >-
        Project-scoped operation. Successful JSON and status-only responses vary
        by operation. The service does not declare a stable response schema for
        this operation; do not assume a collection envelope or undocumented
        fields.
      operationId: GET_shield_analytics_traffic
      parameters:
        - name: domains
          in: query
          required: false
          schema:
            type: array
            title: Domains
            items:
              type: integer
          style: form
          explode: true
        - name: resolution
          in: query
          required: true
          schema:
            type: string
            enum:
              - daily
              - hourly
              - minutely
            title: Resolution
        - name: bucket_size
          in: query
          required: false
          schema:
            title: Bucket Size
            anyOf:
              - type: integer
                enum:
                  - 60
                  - 300
                  - 600
                  - 900
                  - 1800
                  - 3600
                  - 7200
                  - 10800
                  - 21600
                  - 43200
                  - 86400
              - type: 'null'
        - name: start
          in: query
          required: true
          schema:
            type: string
            example: '2024-04-13T00:00:00+01:00'
            title: Start
        - name: end
          in: query
          required: false
          schema:
            title: End
            anyOf:
              - type: string
              - type: 'null'
      responses:
        2XX:
          description: Successful response.
        default:
          description: >-
            Request rejected or service unavailable. See the error code and
            description; refresh before retrying a mutation whose result is
            uncertain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Project API access key.
    apiSecret:
      type: apiKey
      in: header
      name: Aptranet-Secret
      description: Current secret for the access key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.