Analytics collections

GET 
/analytics/collections

Get generic analytics on collections

Request

Query Parameters

start_date stringrequired
Start date from when fetch analytics
Example: 2023-10-12 12:45:00
end_date stringrequired
End date to fetch analytics
Example: 2023-12-12 12:45:00
user_id stringrequired
User ID on which get analytics
Example: 5678456
tag_id stringrequired
Tag ID on which get analytics
Example: 45

Header Parameters

Accept stringrequired
Example: application/json

Responses

200

Response Headers

application/json

Schema

Schema

status stringrequired

views

object[]

required

Array [

total stringrequired

realtime stringrequired

]

sessions

object[]

required

Array [

total stringrequired

average stringrequired

]

interactions

object[]

required

Array [

total stringrequired

comments stringrequired

live_chat stringrequired

]

Example (from schema)

{
  "status": "string",
  "views": [
    {
      "total": "string",
      "realtime": "string"
    }
  ],
  "sessions": [
    {
      "total": "string",
      "average": "string"
    }
  ],
  "interactions": [
    {
      "total": "string",
      "comments": "string",
      "live_chat": "string"
    }
  ]
}

1

OK

{
  "status": "<string>",
  "views": [
    {
      "total": "<string>",
      "realtime": "<string>"
    },
    {
      "total": "<string>",
      "realtime": "<string>"
    }
  ],
  "sessions": [
    {
      "total": "<string>",
      "average": "<string>"
    },
    {
      "total": "<string>",
      "average": "<string>"
    }
  ],
  "interactions": [
    {
      "total": "<string>",
      "comments": "<string>",
      "live_chat": "<string>"
    },
    {
      "total": "<string>",
      "comments": "<string>",
      "live_chat": "<string>"
    }
  ]
}

400

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Bad Request

{
  "status": "<string>"
}

401

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Unauthorized

{
  "status": "<string>"
}

404

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Not Found

{
  "status": "<string>"
}

Loading...