List datasets

client.Radar.Datasets.List(ctx, query) (*DatasetListResponse, error)

GET/radar/datasets

Retrieves a list of datasets.

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

query DatasetListParams

DatasetType param.Field[DatasetListParamsDatasetType]optional

Filters results by dataset type.

const DatasetListParamsDatasetTypeRankingBucket DatasetListParamsDatasetType = "RANKING_BUCKET"

const DatasetListParamsDatasetTypeReport DatasetListParamsDatasetType = "REPORT"

Date param.Field[Time]optional

Filters results by the specified date.

formatdate

Format param.Field[DatasetListParamsFormat]optional

Format in which results will be returned.

const DatasetListParamsFormatJson DatasetListParamsFormat = "JSON"

const DatasetListParamsFormatCsv DatasetListParamsFormat = "CSV"

Limit param.Field[int64]optional

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

Offset param.Field[int64]optional

Skips the specified number of objects before fetching the results.

minimum0

ReturnsExpand Collapse

type DatasetListResponse struct{…}

Datasets []DatasetListResponseDataset

ID int64

Description string

Meta unknown

Tags []string

Title string

Type string

List datasets

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  datasets, err := client.Radar.Datasets.List(context.TODO(), radar.DatasetListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", datasets.Datasets)
}

{
  "result": {
    "datasets": [
      {
        "id": 3,
        "description": "This dataset contains a list of the op 20000 domains globally",
        "meta": {},
        "tags": [
          "global"
        ],
        "title": "Top bucket 20000 domains",
        "type": "RANKING_BUCKET"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "result": {
    "datasets": [
      {
        "id": 3,
        "description": "This dataset contains a list of the op 20000 domains globally",
        "meta": {},
        "tags": [
          "global"
        ],
        "title": "Top bucket 20000 domains",
        "type": "RANKING_BUCKET"
      }
    ]
  },
  "success": true
}