Skip to content

docs(get_signals): Scenarios section uses stale decisioning_platform_segment_id and scope fields instead of activation_key #1540

@torbenbrodt

Description

@torbenbrodt

Summary

get_signals.mdx is internally inconsistent. The schema block and primary examples use activation_key (a structured object), but the Scenarios section further down uses decisioning_platform_segment_id (a plain string) and an undocumented scope field. The Scenarios section is stale.

What the schema says

Both core/deployment.json (v2.5.3 and v3.0.0-rc.2) define exactly one field for targeting keys:

"activation_key": {
  "$ref": "/schemas/2.5.3/core/activation-key.json",
  "description": "The key to use for targeting. Only present if is_live=true AND requester has access to this deployment."
}

activation_key is a typed object with a oneOf discriminator:

  • { "type": "segment_id", "segment_id": "..." }
  • { "type": "key_value", "key": "...", "value": "..." }

There is no decisioning_platform_segment_id field and no scope field in the deployment schema (either version).

What the Scenarios section currently shows (incorrect)

The "All Platforms Discovery", "Response - Multiple Signals Found", and "Response - Partial Success with Warnings" scenarios use:

{
  "type": "platform",
  "platform": "index-exchange",
  "is_live": true,
  "scope": "account-specific",
  "decisioning_platform_segment_id": "ix_agency123_peer39_lux_auto"
}

Both decisioning_platform_segment_id and scope are undefined in the schema.

Required fix

Replace all occurrences of decisioning_platform_segment_id in the Scenarios section with the correct activation_key structure:

{
  "type": "platform",
  "platform": "index-exchange",
  "is_live": true,
  "activation_key": {
    "type": "segment_id",
    "segment_id": "ix_agency123_peer39_lux_auto"
  }
}

Additionally, either:

  • Remove the scope field from the examples (if it was dropped), or
  • Add scope to core/deployment.json with defined semantics (if it should be a valid field)

Notes

  • This is a docs-only fix — the schemas themselves (core/deployment.json, core/activation-key.json) are correct and consistent across v2 and v3
  • Because both deployment variants use additionalProperties: true, the stale examples won't fail schema validation — making this easy to miss
  • decisioning_platform_segment_id appears to be a pre-activation_key field name from an earlier design, never cleaned up in the Scenarios section

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions