Skip to content
Start here

Get Origin Post-Quantum Data Summary

client.Radar.PostQuantum.Origin.Summary(ctx, dimension, query) (*PostQuantumOriginSummaryResponse, error)
GET/radar/post_quantum/origin/summary/{dimension}

Returns a summary of origin post-quantum data grouped by the specified dimension.

Security
API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
User Details WriteUser Details Read
ParametersExpand Collapse

Specifies the origin post-quantum data dimension by which to group the results.

query PostQuantumOriginSummaryParams
DateEnd param.Field[[]Time]Optional

End of the date range (inclusive).

DateRange param.Field[[]string]Optional

Filters results by date range. For example, use 7d and 7dcontrol to compare this week with the previous week. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

DateStart param.Field[[]Time]Optional

Start of the date range.

Format param.Field[PostQuantumOriginSummaryParamsFormat]Optional

Format in which results will be returned.

const PostQuantumOriginSummaryParamsFormatJson PostQuantumOriginSummaryParamsFormat = "JSON"
const PostQuantumOriginSummaryParamsFormatCsv PostQuantumOriginSummaryParamsFormat = "CSV"
Name param.Field[[]string]Optional

Array of names used to label the series in the response.

ReturnsExpand Collapse
type PostQuantumOriginSummaryResponse struct{…}
Meta PostQuantumOriginSummaryResponseMeta

Metadata for the results.

ConfidenceInfo PostQuantumOriginSummaryResponseMetaConfidenceInfo
Annotations []PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotation
DataSource PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAll PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAIBots PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceBGP PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceBots PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceCT PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "CT"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNS PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDos PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceFw PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "FW"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceFwPg PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTP PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceIQI PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceNet PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "NET"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceSpeed PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"
Description string
EndDate Time
formatdate-time
EventType PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventTypeEvent PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventTypeGeneral PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventTypeOutage PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventTypePipeline PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"
const PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly PostQuantumOriginSummaryResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"
IsInstantaneous bool

Whether event is a single point in time or a time range.

LinkedURL string
formaturi
StartDate Time
formatdate-time
Tags []stringOptional
Level int64

Provides an indication of how much confidence Cloudflare has in the data.

DateRange []PostQuantumOriginSummaryResponseMetaDateRange
EndTime Time

Adjusted end of date range.

formatdate-time
StartTime Time

Adjusted start of date range.

formatdate-time
LastUpdated Time

Timestamp of the last dataset update.

formatdate-time
Normalization PostQuantumOriginSummaryResponseMetaNormalization

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
const PostQuantumOriginSummaryResponseMetaNormalizationPercentage PostQuantumOriginSummaryResponseMetaNormalization = "PERCENTAGE"
const PostQuantumOriginSummaryResponseMetaNormalizationMin0Max PostQuantumOriginSummaryResponseMetaNormalization = "MIN0_MAX"
const PostQuantumOriginSummaryResponseMetaNormalizationMinMax PostQuantumOriginSummaryResponseMetaNormalization = "MIN_MAX"
const PostQuantumOriginSummaryResponseMetaNormalizationRawValues PostQuantumOriginSummaryResponseMetaNormalization = "RAW_VALUES"
const PostQuantumOriginSummaryResponseMetaNormalizationPercentageChange PostQuantumOriginSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE"
const PostQuantumOriginSummaryResponseMetaNormalizationRollingAverage PostQuantumOriginSummaryResponseMetaNormalization = "ROLLING_AVERAGE"
const PostQuantumOriginSummaryResponseMetaNormalizationOverlappedPercentage PostQuantumOriginSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"
const PostQuantumOriginSummaryResponseMetaNormalizationRatio PostQuantumOriginSummaryResponseMetaNormalization = "RATIO"
Units []PostQuantumOriginSummaryResponseMetaUnit

Measurement units for the results.

Name string
Value string
Summary0 map[string, string]

Get Origin Post-Quantum Data Summary

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Radar.PostQuantum.Origin.Summary(
    context.TODO(),
    radar.PostQuantumOriginSummaryParamsDimensionKeyAgreement,
    radar.PostQuantumOriginSummaryParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "summary_0": {
      "CurveP256": "99.1234",
      "CurveP384": "85.5678",
      "CurveP521": "45.9012",
      "X25519": "98.3456",
      "X25519MLKEM768": "12.7890"
    }
  },
  "success": true
}
Returns Examples
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "summary_0": {
      "CurveP256": "99.1234",
      "CurveP384": "85.5678",
      "CurveP521": "45.9012",
      "X25519": "98.3456",
      "X25519MLKEM768": "12.7890"
    }
  },
  "success": true
}