Skip to content
Start here

List account or zone datasets

client.Logs.LogExplorer.Datasets.List(ctx, params) (*SinglePage[DatasetSummary], error)
GET/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets

Returns all Log Explorer datasets configured for the account or zone.

Pass include_zones=true to also include zone-level datasets that belong to this account or zone. List responses omit the fields property; use the single-dataset endpoint to retrieve field configuration.

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
Accepted Permissions (at least one required)
Logs WriteLogs Read
ParametersExpand Collapse
params LogExplorerDatasetListParams
AccountID param.Field[string]Optional

Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

ZoneID param.Field[string]Optional

Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

IncludeZones param.Field[bool]Optional

Query param: Set to true to include zone-scoped datasets belonging to this account.

ReturnsExpand Collapse
type DatasetSummary struct{…}

A Log Explorer dataset summary. List endpoints return this type and omit field configuration; use the single-dataset endpoint to retrieve it.

CreatedAt Time

RFC3339 timestamp recording when the API created this dataset.

formatdate-time
Dataset string

Dataset type name (e.g. http_requests).

DatasetID string

Unique dataset ID.

Enabled bool

Whether log ingest is currently active for this dataset.

ObjectID string

Public ID of the account or zone that owns this dataset.

ObjectType DatasetSummaryObjectType

Whether this dataset belongs to an account or a zone.

One of the following:
const DatasetSummaryObjectTypeAccount DatasetSummaryObjectType = "account"
const DatasetSummaryObjectTypeZone DatasetSummaryObjectType = "zone"
UpdatedAt Time

RFC3339 timestamp recording when the API last updated this dataset.

formatdate-time

List account or zone datasets

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Logs.LogExplorer.Datasets.List(context.TODO(), logs.LogExplorerDatasetListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "dataset": "dataset",
      "dataset_id": "dataset_id",
      "enabled": true,
      "object_id": "object_id",
      "object_type": "account",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ]
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "dataset": "dataset",
      "dataset_id": "dataset_id",
      "enabled": true,
      "object_id": "object_id",
      "object_type": "account",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ]
}