List Comment Automation Logs API
The List Comment Automation Logs API returns the recorded activity for a single comment automation. Use it to inspect which comments were processed, how each run ended, and whether private or public replies were sent. The endpoint is a read-only lookup: it does not create, retry, or modify automation runs, so it is the right call when you need evidence for debugging or reporting rather than a change to automation behaviour.
Endpoint summary and authorization
Send a GET request to /v1/comment-automations/{id}/logs, substituting the automation identifier for {id}. The response lists comment automation logs for that one automation only, so keep the identifier scoped to a single automation per request. Every request must carry the access key in the x-access-key header; a request without that header does not meet the documented authorization contract. The worked request is shown in the example titled List failed comment automation logs, first page.
Path and query parameters
The id path parameter is a required string and selects which automation's logs are returned. The three query parameters are all optional. The status filter accepts exactly four literal values: running, succeeded, succeeded_with_warnings, and failed. The limit parameter is an integer between 1 and 100 inclusive, and skip is an integer of 0 or greater. Omitting a query parameter leaves that aspect of the request unconstrained by the documented contract, while supplying an out-of-range limit or skip, or a status outside the four values, falls outside the documented input contract. The full input contract is laid out in the table titled Request parameters.
Reading the 200 response
A 200 response returns a success flag, a logs array, and a pagination object. Each entry in logs carries its own id, the commentId of the processed comment, the commenterId and commenterName of the commenter, the commentText, and the platformPostId of the post the comment appeared on. The per-entry status uses the same four values as the filter, including succeeded_with_warnings. Two reply-outcome fields record what happened after processing: privateReplySent is a boolean, and publicReplyStatus is one of sent, failed, or skipped. The error field is a string or null, and createdAt is a date-time string. The complete field map is in the table titled 200 response fields, with an illustrative payload in the example titled 200 response example.
Paging through comment automation logs
The pagination object reports total, the limit and skip that were applied, and hasMore, which indicates whether more log pages exist beyond the current one. To page through results, increase skip by the number of entries already retrieved while hasMore is true, and stop when hasMore is false. Use the returned total, limit, skip and hasMore fields together when presenting pagination. The captured reference does not define whether total is filter-scoped or specify how partial pages behave, so avoid assuming either rule from a single response.
Error responses
The endpoint documents 400, 403, and 404 responses, each with the same application/json shape of a success flag and a message string, as shown in the example titled Error response example for 400, 403, and 404. The captured contract does not supply specific message text or causes for these codes, so client code should branch on the status code and surface the returned message rather than matching on particular wording. The mapping of each status code to its response shape is summarized in the table titled Response status codes.
Worked example: inspecting failed and warning runs
A practical workflow is to request the failed logs first, using status=failed with a modest limit, then read each entry's error field alongside privateReplySent and publicReplyStatus to see which reply channel was affected. Entries with status succeeded_with_warnings deserve the same inspection, since the status alone does not say whether a private reply, a public reply, or both completed cleanly. Use commentId and platformPostId to correlate a log entry back to the original comment and post, and use createdAt to order events when comparing entries across pages. When hasMore is true, advance skip and repeat until it is false before concluding that the filtered set is complete.
| Parameter | Location | Required | Type | Allowed values or range |
|---|---|---|---|---|
| id | Path | Required | string | Automation identifier substituted into /v1/comment-automations/{id}/logs |
| status | Query | Optional | string | running | succeeded | succeeded_with_warnings | failed |
| limit | Query | Optional | integer | 1 <= value <= 100 |
| skip | Query | Optional | integer | 0 <= value |
Exact captured contract; status enum values are literal strings.
| Field | Type | Required | Notes |
|---|---|---|---|
| success | boolean | Required | Top-level success flag |
| logs | array<object> | Required | Array of log entries |
| logs[].id | string | Required | Log entry identifier |
| logs[].commentId | string | Required | Identifier of the processed comment |
| logs[].commenterId | string | Required | Identifier of the commenter |
| logs[].commenterName | string | null | Required | Commenter name, or null |
| logs[].commentText | string | Required | Text of the processed comment |
| logs[].platformPostId | string | Required | Identifier of the platform post |
| logs[].status | string | Required | running | succeeded | succeeded_with_warnings | failed |
| logs[].privateReplySent | boolean | Required | Whether a private reply was sent |
| logs[].publicReplyStatus | string | Required | sent | failed | skipped |
| logs[].error | string | null | Required | Error detail, or null |
| logs[].createdAt | string | Required | Date-time timestamp |
| pagination | object | Required | Pagination metadata |
| pagination.total | integer | Required | Total matching logs |
| pagination.limit | integer | Required | Limit applied to this page |
| pagination.skip | integer | Required | Skip applied to this page |
| pagination.hasMore | boolean | Required | Whether more pages exist |
Exact captured contract for the 200 application/json response.
| Status code | Content type | Response shape |
|---|---|---|
| 200 | application/json | { success: boolean, logs: array<object>, pagination: object } |
| 400 | application/json | { success: boolean, message: string } |
| 403 | application/json | { success: boolean, message: string } |
| 404 | application/json | { success: boolean, message: string } |
Error message text and causes are not supplied in the captured contract and are not invented here.
curl -X GET "{{API_BASE_URL}}/v1/comment-automations/{id}/logs?status=failed&limit=25&skip=0" \
-H "x-access-key: <token>"{
"success": true,
"logs": [
{
"id": "string",
"commentId": "string",
"commenterId": "string",
"commenterName": "string",
"commentText": "string",
"platformPostId": "string",
"status": "running",
"privateReplySent": true,
"publicReplyStatus": "sent",
"error": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"total": 0,
"limit": 0,
"skip": 0,
"hasMore": true
}
}{
"success": true,
"message": "string"
}| Scope | Field | Type | Type reference | Required | Description | Constraints |
|---|---|---|---|---|---|---|
| id#1 | id | string | __0 | Yes | ||
| status#2 | status | string | __0 | No | ||
| status#2 | status[variant1] | string | __0_extends:__1 | kind: schemaValueIn; value: "running" | ||
| status#2 | status[variant2] | string | __0_extends:__2 | kind: schemaValueIn; value: "succeeded" | ||
| status#2 | status[variant3] | string | __0_extends:__3 | kind: schemaValueIn; value: "succeeded_with_warnings" | ||
| status#2 | status[variant4] | string | __0_extends:__4 | kind: schemaValueIn; value: "failed" | ||
| limit#3 | limit | integer | __0 | No | kind: schemaRange; value: 1 <= value <= 100 | |
| skip#4 | skip | integer | __0 | No | kind: schemaRange; value: 0 <= value | |
| response#5 | response | object | __0 | |||
| response#5 | response.success | boolean | __1 | Yes | ||
| response#5 | response.logs | array<object> | __2 | Yes | ||
| response#5 | response.logs[] | object | __3 | |||
| response#5 | response.logs[].id | string | __4 | Yes | ||
| response#5 | response.logs[].commentId | string | __5 | Yes | ||
| response#5 | response.logs[].commenterId | string | __6 | Yes | ||
| response#5 | response.logs[].commenterName | string | null | __7 | Yes | ||
| response#5 | response.logs[].commenterName[variant1] | string | __7_extends:__8 | |||
| response#5 | response.logs[].commenterName[variant2] | null | __7_extends:__9 | |||
| response#5 | response.logs[].commentText | string | __10 | Yes | ||
| response#5 | response.logs[].platformPostId | string | __11 | Yes | ||
| response#5 | response.logs[].status | string | __12 | Yes | ||
| response#5 | response.logs[].status[variant1] | string | __12_extends:__13 | kind: schemaValueIn; value: "running" | ||
| response#5 | response.logs[].status[variant2] | string | __12_extends:__14 | kind: schemaValueIn; value: "succeeded" | ||
| response#5 | response.logs[].status[variant3] | string | __12_extends:__15 | kind: schemaValueIn; value: "succeeded_with_warnings" | ||
| response#5 | response.logs[].status[variant4] | string | __12_extends:__16 | kind: ; value: "failed" | ||
| response#5 | response.logs[].privateReplySent | boolean | __17 | Yes | ||
| response#5 | response.logs[].publicReplyStatus | string | __18 | Yes | ||
| response#5 | response.logs[].publicReplyStatus[variant1] | string | __18_extends:__19 | kind: ; value: "sent" | ||
| response#5 | response.logs[].publicReplyStatus[variant2] | string | __18_extends:__20 | kind: ; value: "failed" | ||
| response#5 | response.logs[].publicReplyStatus[variant3] | string | __18_extends:__21 | kind: ; value: "skipped" | ||
| response#5 | response.logs[].error | string | null | __22 | Yes | ||
| response#5 | response.logs[].error[variant1] | string | __22_extends:__23 | |||
| response#5 | response.logs[].error[variant2] | null | __22_extends:__24 | |||
| response#5 | response.logs[].createdAt | string | __25 | Yes | kind: ; value: date-time | |
| response#5 | response.pagination | object | __26 | Yes | ||
| response#5 | response.pagination.total | integer | __27 | Yes | ||
| response#5 | response.pagination.limit | integer | __28 | Yes | ||
| response#5 | response.pagination.skip | integer | __29 | Yes | ||
| response#5 | response.pagination.hasMore | boolean | __30 | Yes | ||
| response#6 | response | object | __0 | |||
| response#6 | response.success | boolean | __1 | Yes | ||
| response#6 | response.message | string | __2 | Yes |