Cloudflare API | Spectrum › Analytics › Aggregates › Currents

The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example 1000, or a string to specify a range of origin ports, for example "1000-2000". Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field.

Spectrum

Analytics

spectrum.analytics

Spectrum Analytics

Aggregates

spectrum.analytics.aggregates

Spectrum Analytics Aggregates

Currents

spectrum.analytics.aggregates.currents

Methods

Get Current Aggregated Analytics -> Envelope<Array<{ appID, bytesEgress, bytesIngress, 2 more... }>>

get/zones/{zone_id}/spectrum/analytics/aggregate/current

Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Parameters

zone_id: string

(maxLength: 32)

Identifier

appID: string

Optional

Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.

colo_name: string

Optional

(maxLength: 3)

Co-location identifier.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: Array<{ appID, bytesEgress, bytesIngress, 2 more... }>

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/spectrum/analytics/aggregate/current \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [
    {
      "appID": "023e105f4ecef8ad9ca31a8372d0c353",
      "bytesEgress": 0,
      "bytesIngress": 0,
      "connections": 0,
      "durationAvg": 0
    }
  ]
}

Spectrum Analytics

Events

spectrum.analytics.events

Domain types

Dimension = "event" | "appID" | "coloName" | 1 more...

Spectrum Analytics Events

Bytimes

spectrum.analytics.events.bytimes

Methods

Get Analytics By Time -> Envelope<{ data, data_lag, max, 5 more... }>

get/zones/{zone_id}/spectrum/analytics/events/bytime

Retrieves a list of aggregate metrics grouped by time interval.

Spectrum Analytics Events

Summaries

spectrum.analytics.events.summaries

Methods

Get Analytics Summary -> Envelope<{ data, data_lag, max, 5 more... }>

get/zones/{zone_id}/spectrum/analytics/events/summary

Retrieves a list of summarised aggregate metrics over a given time period.

Spectrum

Apps

spectrum.apps

Methods

Create Spectrum Application Using A Name For The Origin -> Envelope<{ id, created_on, dns, 11 more... } | { id, created_on, dns, 3 more... }>

post/zones/{zone_id}/spectrum/apps

Creates a new Spectrum application from a configuration using a name for the origin.

Delete Spectrum Application -> Envelope<{ id }>

delete/zones/{zone_id}/spectrum/apps/{app_id}

Deletes a previously existing application.

Get Spectrum Application Configuration -> Envelope<{ id, created_on, dns, 11 more... } | { id, created_on, dns, 3 more... }>

get/zones/{zone_id}/spectrum/apps/{app_id}

Gets the application configuration of a specific application inside a zone.

List Spectrum Applications -> V4PagePaginationArray<Array<{ id, created_on, dns, 11 more... }> | Array<{ id, created_on, dns, 3 more... }>>

get/zones/{zone_id}/spectrum/apps

Retrieves a list of currently existing Spectrum applications inside a zone.

Update Spectrum Application Configuration Using A Name For The Origin -> Envelope<{ id, created_on, dns, 11 more... } | { id, created_on, dns, 3 more... }>

put/zones/{zone_id}/spectrum/apps/{app_id}

Updates a previously existing application's configuration that uses a name for the origin.