Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Keywords

Creates a new keyword

Creates a new keyword with the provided name.

post/dashboards/{dashboard_id}/keywords

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

Request body

keyword_valuestring required

Name of the keyword group.

responsestring

Any notes on this keyword group.

Example request

{
  "keyword_value": "Employees",
  "response": "This list will hold all current employees."
}

Response

The new group.

idinteger

The keyword identifier.

subscribers_countinteger

Number of members of the keyword.

keyword_valuestring

Name of the keyword.

date_createdstring date-time

When the keyword was created.

responsestring

The response for the keyword.

group_idinteger

The group associated with this keyword. Use it to retrieve members of the keyword.

Example response

{
  "id": 121,
  "keyword_value": "Employees",
  "date_created": "2022-01-12T19:19:11.8032151Z",
  "group_id": 1
}