comments

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-comments"><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/57640066-85fb-42a7-8a4b-63b2d97d3d40/social-card.svg?v=3e7ae33eec8b" alt="comments" width="600" height="315"></a>
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/comments/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

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

Responses

204
404 Unknown, or not your comment
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/comments

Parameters

project_idstringpathrequired
idstringpathrequired
limitintegerquery
cursorstringquery

Code samples

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

Responses

200 Page of Comment, oldest first
404
POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/comments

Parameters

project_idstringpathrequired
idstringpathrequired

Request body

application/json
bodystringrequired
mentionsstring[]
User ids to notify; non-members are ignored. At most 20.
{
  "body": "string",
  "mentions": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/comments" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","mentions":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201
Example
{
  "author_id": "string",
  "body": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "id": "string",
  "mentions": [
    "string"
  ],
  "resource_id": "string",
  "resource_type": "string"
}
Schema
author_idstring
bodystringrequired
created_atstringrequired
idstringrequired
mentionsstring[]required
resource_idstringrequired
resource_typestringrequired
insight | dashboard
400
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/insights/{id}/comments

Parameters

project_idstringpathrequired
idstringpathrequired
limitintegerquery
cursorstringquery

Code samples

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

Responses

200 Page of Comment, oldest first
404
POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/insights/{id}/comments

Parameters

project_idstringpathrequired
idstringpathrequired

Request body

application/json
bodystringrequired
mentionsstring[]
User ids to notify; non-members are ignored. At most 20.
{
  "body": "string",
  "mentions": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/insights/{id}/comments" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","mentions":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201

Same as 201 · POST /v1/projects/{project_id}/dashboards/{id}/comments

400
404
Updated