Skip to main content
GET
/
insights
/
{insightId}
Get insight
curl --request GET \
  --url https://app.freyavoice.ai/api/v2/insights/{insightId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "insight": {
        "id": "<string>",
        "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "type": "<string>",
        "isRequired": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "enums": [],
        "defaultValue": "<string>",
        "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assignedAgents": [],
        "rangeMin": 123,
        "rangeMax": 123
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

insightId
string
required
Pattern: ^\d+$

Query Parameters

workspaceId
string<uuid>
required

Response

Insight details

success
enum<boolean>
required
Available options:
true
data
object
required