Get dimension values

List what a dimension can be filtered to

API version

GET/v1/signals/{signal_id}/datasources/{datasource_id}/datasets/{dataset_id}/dimensions/{dimension_id}/values

Members under this Signal's entitlements. For most dimensions they are the values present in this DataSet; for a survey (perception) dimension they are the question's answer options — what it can be answered with, which may include a value no respondent picked.

Authenticate with an API key in X-Api-Key, or a bearer token in Authorization: Bearer <token>.

Parameters#

Path parameters#

signal_idstring · required
datasource_idstring · required
dataset_idstring · required
dimension_idstring · required

Example request#

Shell

curl "https://api.odysseysignal.app/v1/signals/{signal_id}/datasources/{datasource_id}/datasets/{dataset_id}/dimensions/{dimension_id}/values" \
  -H "X-Api-Key: $ODYSSEY_API_KEY"

Response 200#

application/json.

The members a dimension can be filtered to, for one DataSource.

environmentstring · nullable
The data environment the answer was read in, prod or test: the one Odyssey set on the Signal, or the one an Odyssey person picked for this call.
dimensionstring · required
sourcestring · required
dataset — enumerated from the data actually in scope; static — a closed list the API defines.
countinteger · required
membersarray of objects · required
Show 6 fieldsHide fields
- idstring or integer · required
- labelstring · required
- groupstring · nullable
- typestring · nullable
- descriptionstring · nullable
- demand_spaceobject · nullable
  For an attribute: the demand space the survey assigns it to. Absent where there is none.
  Show 2 fieldsHide fields
  - idinteger · required
  - labelstring · required

Errors#

Errors are application/problem+json (RFC 9457): type, title, status, detail and, for some, more fields that say how to fix the call. The type is https://api.odysseysignal.app/problems/<code>.

Status	Code	When
400	`invalid-request`	The request is not valid for this DataSet; `detail` says why.
401	`unauthorized`	No credential, or one that is not accepted.
403	`forbidden`	The credential is valid but does not cover what was asked.
404	`not-found`	Nothing there, or nothing this credential may read.
422	`validation-failed`	The request does not match the contract; `errors` lists each field.
429	`rate_limited`	Too many requests, or the monthly quota is used up.
503	`unavailable`	A service behind the API did not answer; try again.