Get recent activity

GET

https://api.sureshake.com/v2/reports/activity

Query parameters

limit
optional
number
maximum: 100 · minimum: 1 · default: 20

offset
optional
number
minimum: 0 · default: 0
unreadOnly
optional
boolean
default: false

Returns

200

Default Response

JSON

data
object
required
- activities
  array of
  object
  required
  id
  string
  required
  eventType
  string
  required
  title
  string
  required
  description
  string
  required
  actionUrl
  string
  required
  actionText
  string
  required
  icon
  string
  required
  iconColor
  string
  required
  timestamp
  string
  required
  format: date-time
  relativeTime
  string
  required
  isRead
  boolean
  required
  isFlagged
  boolean
  required
- total
  number
  required
- hasMore
  boolean
  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": { "activities": [ { "id": "string", "eventType": "string", "title": "string", "description": "string", "actionUrl": "string", "actionText": "string", "icon": "string", "iconColor": "string", "timestamp": "2019-08-24T14:15:22Z", "relativeTime": "string", "isRead": true, "isFlagged": true } ], "total": 0, "hasMore": true }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }