Get communication history

GET

https://api.sureshake.com/v2/analytics/communication-history

Query parameters

userId
optional
string

limit
optional
number
maximum: 100 · minimum: 1 · default: 50
status
optional
array of
string
fromDate
optional
string
format: date-time
toDate
optional
string
format: date-time

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- eventType
  string
  required
- category
  communication
  or
  auth
  or
  profile
  or
  document
  or
  social
  or
  billing
  +1 more
  required
- actorUserId
  string
  or null
  required
- targetUserId
  string
  or null
  required
- entityId
  string
  or null
  required
  format: uuid
- resourceType
  string
  or null
  required
- resourceId
  string
  or null
  required
- payload
  map of
  unknown
  required
- status
  created
  or
  pending
  or
  delivered
  or
  failed
  or
  bounced
  required
- correlationId
  string
  or null
  required
  format: uuid
- sessionId
  string
  or null
  required
  format: uuid
- ipAddress
  string
  or null
  required
- userAgent
  string
  or null
  required
- occurredAt
  string
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- schemaVersion
  string
  required
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

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
}

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
}

Get communication history

curl --request GET \
  --url https://api.sureshake.com/v2/analytics/communication-history

const url = 'https://api.sureshake.com/v2/analytics/communication-history';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "eventType": "string",
      "category": "communication",
      "actorUserId": "string",
      "targetUserId": "string",
      "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
      "resourceType": "string",
      "resourceId": "string",
      "payload": {
        "property1": null,
        "property2": null
      },
      "status": "created",
      "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
      "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
      "ipAddress": "string",
      "userAgent": "string",
      "occurredAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "schemaVersion": "string"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}