Get page analytics

GET

https://api.sureshake.com/v2/reports/{id}/page-analytics

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- reportId
  string
  required
  format: uuid
- periodDays
  90
  required
- pages
  array of
  object
  required
  page
  integer
  required
  totalMs
  integer
  required
  minimum: 0
  viewers
  integer
  required
  minimum: 0
- viewers
  array of
  object
  required
  userId
  string
  required
  name
  string
  or null
  required
  email
  string
  or null
  required
  totalMs
  integer
  required
  minimum: 0
  pagesViewed
  integer
  required
  minimum: 0
  lastViewedAt
  string
  required
  format: date-time
  pages
  array of
  object
  required
  page
  integer
  required
  ms
  integer
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": { "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "periodDays": 90, "pages": [ { "page": 0, "totalMs": 0, "viewers": 0 } ], "viewers": [ { "userId": "string", "name": "string", "email": "string", "totalMs": 0, "pagesViewed": 0, "lastViewedAt": "2019-08-24T14:15:22Z", "pages": [ { "page": 0, "ms": 0 } ] } ] }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }