custom-fields

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-custom-fields"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/5eff06a8-d2c2-41c5-a722-34b34e55d229/social-card.svg?v=3e7ae33eec8b" alt="custom-fields" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields

Parameters

org_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "data": [
    {
      "applies_to": [
        "string"
      ],
      "created_at": "2024-01-01T00:00:00Z",
      "description": "string",
      "id": "string",
      "key": "string",
      "kind": "string",
      "label": "string",
      "options": [
        "string"
      ],
      "position": 0,
      "required": true,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "next_cursor": "string"
}
Schema
dataobject[]required
Show child parameters
applies_tostring[]required
Object types the field shows on: experiment, flag, dashboard.
created_atstringrequired
descriptionstringrequired
idstringrequired
keystringrequired
kindstringrequired
text | number | boolean | select | multi_select | date | url | user.
labelstringrequired
optionsstring[]required
select / multi_select choices.
positionintegerrequired
requiredbooleanrequired
updated_atstringrequired
next_cursorstring
404
POSThttps://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields

Parameters

org_idstringpathrequired

Request body

application/json
applies_tostring[]
Subset of experiment, flag, dashboard (default all three).
descriptionstring
keystringrequired
1-64 chars of a-z 0-9 _; fixed after creation.
kindstringrequired
text | number | boolean | select | multi_select | date | url | user; fixed after creation.
labelstringrequired
optionsstring[]
Choices of select / multi_select (1-100 unique strings).
positioninteger
requiredboolean
{
  "applies_to": [
    "string"
  ],
  "description": "string",
  "key": "string",
  "kind": "string",
  "label": "string",
  "options": [
    "string"
  ],
  "position": 0,
  "required": true
}

Code samples

cURL
curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields" \
  -H "Content-Type: application/json" \
  -d '{"applies_to":["string"],"description":"string","key":"string","kind":"string","label":"string","options":["string"],"position":0,"required":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201
Example
{
  "applies_to": [
    "string"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "key": "string",
  "kind": "string",
  "label": "string",
  "options": [
    "string"
  ],
  "position": 0,
  "required": true,
  "updated_at": "2024-01-01T00:00:00Z"
}
Schema
applies_tostring[]required
Object types the field shows on: experiment, flag, dashboard.
created_atstringrequired
descriptionstringrequired
idstringrequired
keystringrequired
kindstringrequired
text | number | boolean | select | multi_select | date | url | user.
labelstringrequired
optionsstring[]required
select / multi_select choices.
positionintegerrequired
requiredbooleanrequired
updated_atstringrequired
400
403
404
409
PUThttps://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields/{id}

Parameters

org_idstringpathrequired
idstringpathrequired

Request body

application/json
applies_tostring[]
Subset of experiment, flag, dashboard (default all three).
descriptionstring
keystringrequired
1-64 chars of a-z 0-9 _; fixed after creation.
kindstringrequired
text | number | boolean | select | multi_select | date | url | user; fixed after creation.
labelstringrequired
optionsstring[]
Choices of select / multi_select (1-100 unique strings).
positioninteger
requiredboolean
{
  "applies_to": [
    "string"
  ],
  "description": "string",
  "key": "string",
  "kind": "string",
  "label": "string",
  "options": [
    "string"
  ],
  "position": 0,
  "required": true
}

Code samples

cURL
curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields/{id}" \
  -H "Content-Type: application/json" \
  -d '{"applies_to":["string"],"description":"string","key":"string","kind":"string","label":"string","options":["string"],"position":0,"required":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200

Same as 201 · POST /v1/orgs/{org_id}/custom-fields

400 Bad field, or key / kind changed
403
404
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields/{id}

Parameters

org_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/custom-fields/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields

Parameters

project_idstringpathrequired
object_typestringquery
experiment, flag or dashboard

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The org's fields (for one object type)

Same as 200 · GET /v1/orgs/{org_id}/custom-fields

404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields/{object_type}

Parameters

project_idstringpathrequired
object_typestringpathrequired
fieldstringquery
valuestringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields/{object_type}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Values of every object of the type (list columns and filters)
Example
{
  "data": [
    {
      "object_id": "string",
      "values": {}
    }
  ],
  "next_cursor": "string"
}
Schema
dataobject[]required
Show child parameters
object_idstringrequired
valuesobjectrequired
next_cursorstring
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields/{object_type}/{object_id}

Parameters

project_idstringpathrequired
object_typestringpathrequired
object_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields/{object_type}/{object_id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "missing_required": [
    "string"
  ],
  "values": {}
}
Schema
missing_requiredstring[]required
Labels of required fields still empty.
valuesobjectrequired
404
PUThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields/{object_type}/{object_id}

Parameters

project_idstringpathrequired
object_typestringpathrequired
object_idstringpathrequired

Request body

application/json

{field key: value}; null clears

{}

Code samples

cURL
curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/custom-fields/{object_type}/{object_id}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200

Same as 200 · GET /v1/projects/{project_id}/custom-fields/{object_type}/{object_id}

400 Unknown field, wrong type or a required field left empty
403
404
Updated