Component schema

DatasetSettings

object1 direct reference

Definition

Datasetrequired

Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

stringrequired

integer

boolean

string

DatasetTracingSettingsrequired

DatasetLoggingSettingsrequired

DatasetMetricsSettingsrequired

DatasetProfilingSettingsrequired

DatasetWebEventsSettingsrequired

SemanticConventionUpgradesrequired

Choose whether or not semantic convention upgrades should be executed. Can be one of:

disabled: No upgrade will be executed
latest: We will always upgrade to the latest and greatest
vX.X.X: A SEMVER version. We will automatically upgrade up to that version (inclusive)

Defaults to latest for new organizations.

TelemetryFilter[]required

IpAddressesSettingsrequired

GeoLocationSettingsrequired

GenAIAttributeRedactionSettings

Controls redaction of supported GenAI attributes before Collector export. Absent policies default to disabled for new and existing datasets.

CardholderDataRedactionSettings

Controls detection and redaction of payment card numbers and related sensitive data before Dash0 persists the signal. Absent means disabled for new and existing datasets.

DarkplaneConfig

Darkplane-specific opt-ins for this dataset. Absent opt-ins default to disabled for new and existing datasets.

DatasetPermission[]

DatasetAction[]

Used by 1

These schemas and endpoints reference this type directly.

SchemaSettingsPerOrganizationAndDatasetInfo

json

OpenAPI source12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
{
  "properties": {
    "slug": {
      "$ref": "#/components/schemas/Dataset"
    },
    "name": {
      "type": "string"
    },
    "version": {
      "type": "integer"
    },
    "preferred": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "tracing": {
      "$ref": "#/components/schemas/DatasetTracingSettings"
    },
    "logging": {
      "$ref": "#/components/schemas/DatasetLoggingSettings"
    },
    "metrics": {
      "$ref": "#/components/schemas/DatasetMetricsSettings"
    },
    "profiling": {
      "$ref": "#/components/schemas/DatasetProfilingSettings"
    },
    "webEvents": {
      "$ref": "#/components/schemas/DatasetWebEventsSettings"
    },
    "semanticConventionUpgrades": {
      "$ref": "#/components/schemas/SemanticConventionUpgrades"
    },
    "telemetryFilters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TelemetryFilter"
      }
    },
    "ipAddresses": {
      "$ref": "#/components/schemas/IpAddressesSettings"
    },
    "geoLocation": {
      "$ref": "#/components/schemas/GeoLocationSettings"
    },
    "genAiAttributeRedaction": {
      "$ref": "#/components/schemas/GenAIAttributeRedactionSettings",
      "description": "Controls redaction of supported GenAI attributes before Collector export.\nAbsent policies default to `disabled` for new and existing datasets.\n"
    },
    "cardholderDataRedaction": {
      "$ref": "#/components/schemas/CardholderDataRedactionSettings",
      "description": "Controls detection and redaction of payment card numbers and related sensitive data before\nDash0 persists the signal. Absent means disabled for new and existing datasets.\n"
    },
    "darkplane": {
      "$ref": "#/components/schemas/DarkplaneConfig",
      "description": "Darkplane-specific opt-ins for this dataset.\nAbsent opt-ins default to `disabled` for new and existing datasets.\n"
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DatasetPermission"
      }
    },
    "permittedActions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DatasetAction"
      }
    }
  },
  "required": [
    "slug",
    "name",
    "tracing",
    "logging",
    "metrics",
    "profiling",
    "webEvents",
    "semanticConventionUpgrades",
    "telemetryFilters",
    "ipAddresses",
    "geoLocation"
  ]
}