Skip to content

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.

Request parameters
ParameterLocationRequiredTypeAllowed values or range
idPathRequiredstringAutomation identifier substituted into /v1/comment-automations/{id}/logs
statusQueryOptionalstringrunning | succeeded | succeeded_with_warnings | failed
limitQueryOptionalinteger1 <= value <= 100
skipQueryOptionalinteger0 <= value

Exact captured contract; status enum values are literal strings.

200 response fields
FieldTypeRequiredNotes
successbooleanRequiredTop-level success flag
logsarray<object>RequiredArray of log entries
logs[].idstringRequiredLog entry identifier
logs[].commentIdstringRequiredIdentifier of the processed comment
logs[].commenterIdstringRequiredIdentifier of the commenter
logs[].commenterNamestring | nullRequiredCommenter name, or null
logs[].commentTextstringRequiredText of the processed comment
logs[].platformPostIdstringRequiredIdentifier of the platform post
logs[].statusstringRequiredrunning | succeeded | succeeded_with_warnings | failed
logs[].privateReplySentbooleanRequiredWhether a private reply was sent
logs[].publicReplyStatusstringRequiredsent | failed | skipped
logs[].errorstring | nullRequiredError detail, or null
logs[].createdAtstringRequiredDate-time timestamp
paginationobjectRequiredPagination metadata
pagination.totalintegerRequiredTotal matching logs
pagination.limitintegerRequiredLimit applied to this page
pagination.skipintegerRequiredSkip applied to this page
pagination.hasMorebooleanRequiredWhether more pages exist

Exact captured contract for the 200 application/json response.

Response status codes
Status codeContent typeResponse shape
200application/json{ success: boolean, logs: array<object>, pagination: object }
400application/json{ success: boolean, message: string }
403application/json{ success: boolean, message: string }
404application/json{ success: boolean, message: string }

Error message text and causes are not supplied in the captured contract and are not invented here.

List failed comment automation logs, first page
curl -X GET "{{API_BASE_URL}}/v1/comment-automations/{id}/logs?status=failed&limit=25&skip=0" \
  -H "x-access-key: <token>"
200 response example
{
  "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
  }
}
Error response example for 400, 403, and 404
{
  "success": true,
  "message": "string"
}
Interface fields
ScopeFieldTypeType referenceRequiredDescriptionConstraints
id#1idstring__0Yes
status#2statusstring__0No
status#2status[variant1]string__0_extends:__1kind: schemaValueIn; value: "running"
status#2status[variant2]string__0_extends:__2kind: schemaValueIn; value: "succeeded"
status#2status[variant3]string__0_extends:__3kind: schemaValueIn; value: "succeeded_with_warnings"
status#2status[variant4]string__0_extends:__4kind: schemaValueIn; value: "failed"
limit#3limitinteger__0Nokind: schemaRange; value: 1 <= value <= 100
skip#4skipinteger__0Nokind: schemaRange; value: 0 <= value
response#5responseobject__0
response#5response.successboolean__1Yes
response#5response.logsarray<object>__2Yes
response#5response.logs[]object__3
response#5response.logs[].idstring__4Yes
response#5response.logs[].commentIdstring__5Yes
response#5response.logs[].commenterIdstring__6Yes
response#5response.logs[].commenterNamestring | null__7Yes
response#5response.logs[].commenterName[variant1]string__7_extends:__8
response#5response.logs[].commenterName[variant2]null__7_extends:__9
response#5response.logs[].commentTextstring__10Yes
response#5response.logs[].platformPostIdstring__11Yes
response#5response.logs[].statusstring__12Yes
response#5response.logs[].status[variant1]string__12_extends:__13kind: schemaValueIn; value: "running"
response#5response.logs[].status[variant2]string__12_extends:__14kind: schemaValueIn; value: "succeeded"
response#5response.logs[].status[variant3]string__12_extends:__15kind: schemaValueIn; value: "succeeded_with_warnings"
response#5response.logs[].status[variant4]string__12_extends:__16kind: ; value: "failed"
response#5response.logs[].privateReplySentboolean__17Yes
response#5response.logs[].publicReplyStatusstring__18Yes
response#5response.logs[].publicReplyStatus[variant1]string__18_extends:__19kind: ; value: "sent"
response#5response.logs[].publicReplyStatus[variant2]string__18_extends:__20kind: ; value: "failed"
response#5response.logs[].publicReplyStatus[variant3]string__18_extends:__21kind: ; value: "skipped"
response#5response.logs[].errorstring | null__22Yes
response#5response.logs[].error[variant1]string__22_extends:__23
response#5response.logs[].error[variant2]null__22_extends:__24
response#5response.logs[].createdAtstring__25Yeskind: ; value: date-time
response#5response.paginationobject__26Yes
response#5response.pagination.totalinteger__27Yes
response#5response.pagination.limitinteger__28Yes
response#5response.pagination.skipinteger__29Yes
response#5response.pagination.hasMoreboolean__30Yes
response#6responseobject__0
response#6response.successboolean__1Yes
response#6response.messagestring__2Yes