# Datasets

# Fields

## List fields

`client.Logpush.Datasets.Fields.Get(ctx, datasetID, query) (*DatasetFieldGetResponse, error)`

**get** `/{accounts_or_zones}/{account_or_zone_id}/logpush/datasets/{dataset_id}/fields`

Lists all fields available for a dataset. The response result is. an object with key-value pairs, where keys are field names, and values are descriptions.

### Parameters

- `datasetID DatasetFieldGetParamsDatasetID`

  Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

  - `const DatasetFieldGetParamsDatasetIDAccessRequests DatasetFieldGetParamsDatasetID = "access_requests"`

  - `const DatasetFieldGetParamsDatasetIDAuditLogs DatasetFieldGetParamsDatasetID = "audit_logs"`

  - `const DatasetFieldGetParamsDatasetIDAuditLogsV2 DatasetFieldGetParamsDatasetID = "audit_logs_v2"`

  - `const DatasetFieldGetParamsDatasetIDBISOUserActions DatasetFieldGetParamsDatasetID = "biso_user_actions"`

  - `const DatasetFieldGetParamsDatasetIDCasbFindings DatasetFieldGetParamsDatasetID = "casb_findings"`

  - `const DatasetFieldGetParamsDatasetIDDevicePostureResults DatasetFieldGetParamsDatasetID = "device_posture_results"`

  - `const DatasetFieldGetParamsDatasetIDDEXApplicationTests DatasetFieldGetParamsDatasetID = "dex_application_tests"`

  - `const DatasetFieldGetParamsDatasetIDDEXDeviceStateEvents DatasetFieldGetParamsDatasetID = "dex_device_state_events"`

  - `const DatasetFieldGetParamsDatasetIDDLPForensicCopies DatasetFieldGetParamsDatasetID = "dlp_forensic_copies"`

  - `const DatasetFieldGetParamsDatasetIDDNSFirewallLogs DatasetFieldGetParamsDatasetID = "dns_firewall_logs"`

  - `const DatasetFieldGetParamsDatasetIDDNSLogs DatasetFieldGetParamsDatasetID = "dns_logs"`

  - `const DatasetFieldGetParamsDatasetIDEmailSecurityAlerts DatasetFieldGetParamsDatasetID = "email_security_alerts"`

  - `const DatasetFieldGetParamsDatasetIDFirewallEvents DatasetFieldGetParamsDatasetID = "firewall_events"`

  - `const DatasetFieldGetParamsDatasetIDGatewayDNS DatasetFieldGetParamsDatasetID = "gateway_dns"`

  - `const DatasetFieldGetParamsDatasetIDGatewayHTTP DatasetFieldGetParamsDatasetID = "gateway_http"`

  - `const DatasetFieldGetParamsDatasetIDGatewayNetwork DatasetFieldGetParamsDatasetID = "gateway_network"`

  - `const DatasetFieldGetParamsDatasetIDHTTPRequests DatasetFieldGetParamsDatasetID = "http_requests"`

  - `const DatasetFieldGetParamsDatasetIDIPSECLogs DatasetFieldGetParamsDatasetID = "ipsec_logs"`

  - `const DatasetFieldGetParamsDatasetIDMagicIDsDetections DatasetFieldGetParamsDatasetID = "magic_ids_detections"`

  - `const DatasetFieldGetParamsDatasetIDNELReports DatasetFieldGetParamsDatasetID = "nel_reports"`

  - `const DatasetFieldGetParamsDatasetIDNetworkAnalyticsLogs DatasetFieldGetParamsDatasetID = "network_analytics_logs"`

  - `const DatasetFieldGetParamsDatasetIDPageShieldEvents DatasetFieldGetParamsDatasetID = "page_shield_events"`

  - `const DatasetFieldGetParamsDatasetIDSinkholeHTTPLogs DatasetFieldGetParamsDatasetID = "sinkhole_http_logs"`

  - `const DatasetFieldGetParamsDatasetIDSpectrumEvents DatasetFieldGetParamsDatasetID = "spectrum_events"`

  - `const DatasetFieldGetParamsDatasetIDSSHLogs DatasetFieldGetParamsDatasetID = "ssh_logs"`

  - `const DatasetFieldGetParamsDatasetIDWARPConfigChanges DatasetFieldGetParamsDatasetID = "warp_config_changes"`

  - `const DatasetFieldGetParamsDatasetIDWARPToggleChanges DatasetFieldGetParamsDatasetID = "warp_toggle_changes"`

  - `const DatasetFieldGetParamsDatasetIDWorkersTraceEvents DatasetFieldGetParamsDatasetID = "workers_trace_events"`

  - `const DatasetFieldGetParamsDatasetIDZarazEvents DatasetFieldGetParamsDatasetID = "zaraz_events"`

  - `const DatasetFieldGetParamsDatasetIDZeroTrustNetworkSessions DatasetFieldGetParamsDatasetID = "zero_trust_network_sessions"`

- `query DatasetFieldGetParams`

  - `AccountID param.Field[string]`

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

  - `ZoneID param.Field[string]`

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

### Returns

- `type DatasetFieldGetResponse interface{…}`

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  field, err := client.Logpush.Datasets.Fields.Get(
    context.TODO(),
    logpush.DatasetFieldGetParamsDatasetIDGatewayDNS,
    logpush.DatasetFieldGetParams{

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

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {}
}
```

# Jobs

## List Logpush jobs for a dataset

`client.Logpush.Datasets.Jobs.Get(ctx, datasetID, query) (*SinglePage[LogpushJob], error)`

**get** `/{accounts_or_zones}/{account_or_zone_id}/logpush/datasets/{dataset_id}/jobs`

Lists Logpush jobs for an account or zone for a dataset.

### Parameters

- `datasetID DatasetJobGetParamsDatasetID`

  Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

  - `const DatasetJobGetParamsDatasetIDAccessRequests DatasetJobGetParamsDatasetID = "access_requests"`

  - `const DatasetJobGetParamsDatasetIDAuditLogs DatasetJobGetParamsDatasetID = "audit_logs"`

  - `const DatasetJobGetParamsDatasetIDAuditLogsV2 DatasetJobGetParamsDatasetID = "audit_logs_v2"`

  - `const DatasetJobGetParamsDatasetIDBISOUserActions DatasetJobGetParamsDatasetID = "biso_user_actions"`

  - `const DatasetJobGetParamsDatasetIDCasbFindings DatasetJobGetParamsDatasetID = "casb_findings"`

  - `const DatasetJobGetParamsDatasetIDDevicePostureResults DatasetJobGetParamsDatasetID = "device_posture_results"`

  - `const DatasetJobGetParamsDatasetIDDEXApplicationTests DatasetJobGetParamsDatasetID = "dex_application_tests"`

  - `const DatasetJobGetParamsDatasetIDDEXDeviceStateEvents DatasetJobGetParamsDatasetID = "dex_device_state_events"`

  - `const DatasetJobGetParamsDatasetIDDLPForensicCopies DatasetJobGetParamsDatasetID = "dlp_forensic_copies"`

  - `const DatasetJobGetParamsDatasetIDDNSFirewallLogs DatasetJobGetParamsDatasetID = "dns_firewall_logs"`

  - `const DatasetJobGetParamsDatasetIDDNSLogs DatasetJobGetParamsDatasetID = "dns_logs"`

  - `const DatasetJobGetParamsDatasetIDEmailSecurityAlerts DatasetJobGetParamsDatasetID = "email_security_alerts"`

  - `const DatasetJobGetParamsDatasetIDFirewallEvents DatasetJobGetParamsDatasetID = "firewall_events"`

  - `const DatasetJobGetParamsDatasetIDGatewayDNS DatasetJobGetParamsDatasetID = "gateway_dns"`

  - `const DatasetJobGetParamsDatasetIDGatewayHTTP DatasetJobGetParamsDatasetID = "gateway_http"`

  - `const DatasetJobGetParamsDatasetIDGatewayNetwork DatasetJobGetParamsDatasetID = "gateway_network"`

  - `const DatasetJobGetParamsDatasetIDHTTPRequests DatasetJobGetParamsDatasetID = "http_requests"`

  - `const DatasetJobGetParamsDatasetIDIPSECLogs DatasetJobGetParamsDatasetID = "ipsec_logs"`

  - `const DatasetJobGetParamsDatasetIDMagicIDsDetections DatasetJobGetParamsDatasetID = "magic_ids_detections"`

  - `const DatasetJobGetParamsDatasetIDNELReports DatasetJobGetParamsDatasetID = "nel_reports"`

  - `const DatasetJobGetParamsDatasetIDNetworkAnalyticsLogs DatasetJobGetParamsDatasetID = "network_analytics_logs"`

  - `const DatasetJobGetParamsDatasetIDPageShieldEvents DatasetJobGetParamsDatasetID = "page_shield_events"`

  - `const DatasetJobGetParamsDatasetIDSinkholeHTTPLogs DatasetJobGetParamsDatasetID = "sinkhole_http_logs"`

  - `const DatasetJobGetParamsDatasetIDSpectrumEvents DatasetJobGetParamsDatasetID = "spectrum_events"`

  - `const DatasetJobGetParamsDatasetIDSSHLogs DatasetJobGetParamsDatasetID = "ssh_logs"`

  - `const DatasetJobGetParamsDatasetIDWARPConfigChanges DatasetJobGetParamsDatasetID = "warp_config_changes"`

  - `const DatasetJobGetParamsDatasetIDWARPToggleChanges DatasetJobGetParamsDatasetID = "warp_toggle_changes"`

  - `const DatasetJobGetParamsDatasetIDWorkersTraceEvents DatasetJobGetParamsDatasetID = "workers_trace_events"`

  - `const DatasetJobGetParamsDatasetIDZarazEvents DatasetJobGetParamsDatasetID = "zaraz_events"`

  - `const DatasetJobGetParamsDatasetIDZeroTrustNetworkSessions DatasetJobGetParamsDatasetID = "zero_trust_network_sessions"`

- `query DatasetJobGetParams`

  - `AccountID param.Field[string]`

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

  - `ZoneID param.Field[string]`

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

### Returns

- `type LogpushJob struct{…}`

  - `ID int64`

    Unique id of the job.

  - `Dataset LogpushJobDataset`

    Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

    - `const LogpushJobDatasetAccessRequests LogpushJobDataset = "access_requests"`

    - `const LogpushJobDatasetAuditLogs LogpushJobDataset = "audit_logs"`

    - `const LogpushJobDatasetAuditLogsV2 LogpushJobDataset = "audit_logs_v2"`

    - `const LogpushJobDatasetBISOUserActions LogpushJobDataset = "biso_user_actions"`

    - `const LogpushJobDatasetCasbFindings LogpushJobDataset = "casb_findings"`

    - `const LogpushJobDatasetDevicePostureResults LogpushJobDataset = "device_posture_results"`

    - `const LogpushJobDatasetDEXApplicationTests LogpushJobDataset = "dex_application_tests"`

    - `const LogpushJobDatasetDEXDeviceStateEvents LogpushJobDataset = "dex_device_state_events"`

    - `const LogpushJobDatasetDLPForensicCopies LogpushJobDataset = "dlp_forensic_copies"`

    - `const LogpushJobDatasetDNSFirewallLogs LogpushJobDataset = "dns_firewall_logs"`

    - `const LogpushJobDatasetDNSLogs LogpushJobDataset = "dns_logs"`

    - `const LogpushJobDatasetEmailSecurityAlerts LogpushJobDataset = "email_security_alerts"`

    - `const LogpushJobDatasetFirewallEvents LogpushJobDataset = "firewall_events"`

    - `const LogpushJobDatasetGatewayDNS LogpushJobDataset = "gateway_dns"`

    - `const LogpushJobDatasetGatewayHTTP LogpushJobDataset = "gateway_http"`

    - `const LogpushJobDatasetGatewayNetwork LogpushJobDataset = "gateway_network"`

    - `const LogpushJobDatasetHTTPRequests LogpushJobDataset = "http_requests"`

    - `const LogpushJobDatasetIPSECLogs LogpushJobDataset = "ipsec_logs"`

    - `const LogpushJobDatasetMagicIDsDetections LogpushJobDataset = "magic_ids_detections"`

    - `const LogpushJobDatasetNELReports LogpushJobDataset = "nel_reports"`

    - `const LogpushJobDatasetNetworkAnalyticsLogs LogpushJobDataset = "network_analytics_logs"`

    - `const LogpushJobDatasetPageShieldEvents LogpushJobDataset = "page_shield_events"`

    - `const LogpushJobDatasetSinkholeHTTPLogs LogpushJobDataset = "sinkhole_http_logs"`

    - `const LogpushJobDatasetSpectrumEvents LogpushJobDataset = "spectrum_events"`

    - `const LogpushJobDatasetSSHLogs LogpushJobDataset = "ssh_logs"`

    - `const LogpushJobDatasetWARPConfigChanges LogpushJobDataset = "warp_config_changes"`

    - `const LogpushJobDatasetWARPToggleChanges LogpushJobDataset = "warp_toggle_changes"`

    - `const LogpushJobDatasetWorkersTraceEvents LogpushJobDataset = "workers_trace_events"`

    - `const LogpushJobDatasetZarazEvents LogpushJobDataset = "zaraz_events"`

    - `const LogpushJobDatasetZeroTrustNetworkSessions LogpushJobDataset = "zero_trust_network_sessions"`

  - `DestinationConf string`

    Uniquely identifies a resource (such as an s3 bucket) where data. will be pushed. Additional configuration parameters supported by the destination may be included.

  - `Enabled bool`

    Flag that indicates if the job is enabled.

  - `ErrorMessage string`

    If not null, the job is currently failing. Failures are usually. repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.

  - `Frequency LogpushJobFrequency`

    This field is deprecated. Please use `max_upload_*` parameters instead. . The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

    - `const LogpushJobFrequencyHigh LogpushJobFrequency = "high"`

    - `const LogpushJobFrequencyLow LogpushJobFrequency = "low"`

  - `Kind LogpushJobKind`

    The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).

    - `const LogpushJobKindEmpty LogpushJobKind = ""`

    - `const LogpushJobKindEdge LogpushJobKind = "edge"`

  - `LastComplete Time`

    Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.

  - `LastError Time`

    Records the last time the job failed. If not null, the job is currently. failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.

  - `LogpullOptions string`

    This field is deprecated. Use `output_options` instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

  - `MaxUploadBytes LogpushJobMaxUploadBytes`

    The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.

    - `type LogpushJobMaxUploadBytes int64`

      The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.

      - `const LogpushJobMaxUploadBytes0 LogpushJobMaxUploadBytes = 0`

    - `int64`

  - `MaxUploadIntervalSeconds LogpushJobMaxUploadIntervalSeconds`

    The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this.

    - `type LogpushJobMaxUploadIntervalSeconds int64`

      The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this.

      - `const LogpushJobMaxUploadIntervalSeconds0 LogpushJobMaxUploadIntervalSeconds = 0`

    - `int64`

  - `MaxUploadRecords LogpushJobMaxUploadRecords`

    The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.

    - `type LogpushJobMaxUploadRecords int64`

      The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.

      - `const LogpushJobMaxUploadRecords0 LogpushJobMaxUploadRecords = 0`

    - `int64`

  - `Name string`

    Optional human readable job name. Not unique. Cloudflare suggests. that you set this to a meaningful string, like the domain name, to make it easier to identify your job.

  - `OutputOptions OutputOptions`

    The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.

    - `BatchPrefix string`

      String to be prepended before each batch.

    - `BatchSuffix string`

      String to be appended after each batch.

    - `Cve2021_44228 bool`

      If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.

    - `FieldDelimiter string`

      String to join fields. This field be ignored when `record_template` is set.

    - `FieldNames []string`

      List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.

    - `MergeSubrequests bool`

      If set to true, subrequests will be merged into the parent request. Only supported for the `http_requests` dataset.

    - `OutputType OutputOptionsOutputType`

      Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.

      - `const OutputOptionsOutputTypeNdjson OutputOptionsOutputType = "ndjson"`

      - `const OutputOptionsOutputTypeCsv OutputOptionsOutputType = "csv"`

    - `RecordDelimiter string`

      String to be inserted in-between the records as separator.

    - `RecordPrefix string`

      String to be prepended before each record.

    - `RecordSuffix string`

      String to be appended after each record.

    - `RecordTemplate string`

      String to use as template for each record instead of the default json key value mapping. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc.

    - `SampleRate float64`

      Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.

    - `TimestampFormat OutputOptionsTimestampFormat`

      String to specify the format for timestamps, such as `unixnano`, `unix`, `rfc3339`, `rfc3339ms` or `rfc3339ns`.

      - `const OutputOptionsTimestampFormatUnixnano OutputOptionsTimestampFormat = "unixnano"`

      - `const OutputOptionsTimestampFormatUnix OutputOptionsTimestampFormat = "unix"`

      - `const OutputOptionsTimestampFormatRfc3339 OutputOptionsTimestampFormat = "rfc3339"`

      - `const OutputOptionsTimestampFormatRfc3339ms OutputOptionsTimestampFormat = "rfc3339ms"`

      - `const OutputOptionsTimestampFormatRfc3339ns OutputOptionsTimestampFormat = "rfc3339ns"`

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Logpush.Datasets.Jobs.Get(
    context.TODO(),
    logpush.DatasetJobGetParamsDatasetIDGatewayDNS,
    logpush.DatasetJobGetParams{

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

#### Response

```json
{
  "errors": [],
  "messages": [],
  "result": [
    {
      "dataset": "gateway_dns",
      "destination_conf": "s3://mybucket/logs?region=us-west-2",
      "enabled": false,
      "error_message": null,
      "filter": "{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}",
      "id": 1,
      "kind": "",
      "last_complete": null,
      "last_error": null,
      "max_upload_bytes": 5000000,
      "max_upload_interval_seconds": 30,
      "max_upload_records": 1000,
      "name": "example.com",
      "output_options": {
        "CVE-2021-44228": false,
        "batch_prefix": "",
        "batch_suffix": "",
        "field_delimiter": ",",
        "field_names": [
          "Datetime",
          "DstIP",
          "SrcIP"
        ],
        "output_type": "ndjson",
        "record_delimiter": "",
        "record_prefix": "{",
        "record_suffix": "}\n",
        "sample_rate": 1,
        "timestamp_format": "unixnano"
      }
    }
  ],
  "success": true
}
```