Skip to main content
GET
/
comments
/
v2
/
rs
/
origin
/
{originType}
/
{originId}
/
count
Count comments for the given criteria
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/comments/v2/rs/origin/{originType}/{originId}/count \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "count": 42
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-sites
string

List of site IDs.

Example:

"['1', '2']"

Path Parameters

​
originType
enum<number>
required

Type of entity to attach to.

Available options:
1,
2
Example:

1

​
originId
integer
required

ID of the entity to attach to.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

123

Query Parameters

​
whereCreatedById
integer

Filter by user id

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereCreatedByName
string

Filter by user name (contains)

Example:

"string"

​
whereComment
string

Filter by comment content (contains)

Example:

"string"

​
whereUpdatedAt
object

Filter by update date

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedAt
object

Filter by createdAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}

Response

200 - application/json

Count of comments

​
count
integer
required

Total count of items

Required range: 0 <= x <= 9007199254740991
Example:

42