Skip to main content
GET
/
analytics
/
structured-data
Get structured data analytics
curl --request GET \
  --url https://app2.freyavoice.ai/api/v2/analytics/structured-data \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "workspaceId": "<string>",
      "timeRange": {
        "start": "<string>",
        "end": "<string>"
      },
      "granularity": "hour",
      "fields": [
        {
          "id": 123,
          "name": "<string>",
          "type": "<string>",
          "agentId": 123,
          "agentName": "<string>"
        }
      ],
      "data": [
        {
          "structuredDataId": 123,
          "timeSeries": [
            {
              "date": "<string>",
              "count": 123,
              "avg": 123,
              "sum": 123,
              "min": 123,
              "max": 123,
              "trueCount": 123,
              "falseCount": 123
            }
          ],
          "summary": {
            "count": 123,
            "avg": 123,
            "sum": 123,
            "min": 123,
            "max": 123,
            "trueCount": 123,
            "falseCount": 123,
            "trueRate": 123
          },
          "distribution": {},
          "valueCounts": {}
        }
      ],
      "generatedAt": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

workspaceId
string<uuid>
required
Minimum string length: 1
startDate
string
endDate
string
granularity
enum<string>
default:day
Available options:
hour,
day,
month
agentIds
integer[]
structuredDataIds
integer[]
assistantIds
string[]
callTypes
string[]
phoneNumberId
string<uuid>

Response

Structured data analytics

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