Comments API
Publish comments and replies, import the comments people left on your posts and moderate them.
| Operation | Method and path |
|---|---|
| Start a new comment import for a post | POST /api/v1/comment/import |
| Get comment import list | GET /api/v1/comment/import |
| Get fetched comments for a post | GET /api/v1/comment/import/comments |
| Run an action on a fetched comment | POST /api/v1/comment/import/comments/{commentId}/action |
| Get comment import by ID | GET /api/v1/comment/import/{importId} |
| Get comment | GET /api/v1/comment/{id} |
| Update comment | PATCH /api/v1/comment/{id} |
| Delete comment | DELETE /api/v1/comment/{id} |
| Get comment list | GET /api/v1/comment |
| Create comment | POST /api/v1/comment |
| Retry comment | POST /api/v1/comment/{id}/retry |
/api/v1/comment/import Start a new comment import for a post
comment.importCreate · requires x-api-key
Request body application/json
-
teamIdstring required -
postIdstring -
importedPostIdstring -
socialAccountTypestring requiredOne of:FACEBOOKINSTAGRAMLINKEDINYOUTUBETIKTOKREDDITTHREADSMASTODONBLUESKYTWITTER
Example
curl -X POST "https://api.siaran.my/api/v1/comment/import" \
-H "x-api-key: $SIAR_API_KEY" \
-H "content-type: application/json" \
-d '{
"teamId": "TEAM_ID",
"socialAccountType": "FACEBOOK"
}' Response 201
15 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
socialAccountIdstring required -
postIdstring nullable -
importedPostIdstring nullable -
platformstring requiredOne of:FACEBOOKINSTAGRAMLINKEDINYOUTUBETIKTOKREDDITTHREADSMASTODONBLUESKYTWITTER -
statusstring requiredOne of:PENDINGFETCHINGRETRYINGCOMPLETEDSKIPPEDFAILEDRATE_LIMITED -
commentsImportednumber required -
errorstring nullable -
rateLimitResetAtstring nullable date-time -
startedAtstring nullable date-time -
completedAtstring nullable date-time -
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 409 Conflict · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/import Get comment import list
comment.importGetList · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
teamId required | query | string | |
postId | query | string | |
importedPostId | query | string | |
status | query | string | One of PENDING, FETCHING, RETRYING, COMPLETED, SKIPPED, FAILED, RATE_LIMITED |
offset | query | number | default 0 · nullable |
limit | query | number | default 10 · nullable |
Example
curl -X GET "https://api.siaran.my/api/v1/comment/import?teamId=TEAM_ID" \
-H "x-api-key: $SIAR_API_KEY" Response 200
1 top-level fields
-
importsobject[] required15 fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
socialAccountIdstring required -
postIdstring nullable -
importedPostIdstring nullable -
platformstring requiredOne of:FACEBOOKINSTAGRAMLINKEDINYOUTUBETIKTOKREDDITTHREADSMASTODONBLUESKYTWITTER -
statusstring requiredOne of:PENDINGFETCHINGRETRYINGCOMPLETEDSKIPPEDFAILEDRATE_LIMITED -
commentsImportednumber required -
errorstring nullable -
rateLimitResetAtstring nullable date-time -
startedAtstring nullable date-time -
completedAtstring nullable date-time -
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time
-
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/import/comments Get fetched comments for a post
comment.importGetFetchedComments · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
teamId required | query | string | |
postId | query | string | |
importedPostId | query | string | |
platform | query | string | One of FACEBOOK, INSTAGRAM, LINKEDIN, YOUTUBE, TIKTOK, REDDIT, THREADS, MASTODON, BLUESKY, TWITTER |
socialAccountId | query | string | |
offset | query | number | default 0 · nullable |
limit | query | number | default 10 · nullable |
Example
curl -X GET "https://api.siaran.my/api/v1/comment/import/comments?teamId=TEAM_ID" \
-H "x-api-key: $SIAR_API_KEY" Response 200
2 top-level fields
-
itemsobject[] required23 fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
postIdstring nullable -
importedPostIdstring nullable -
socialAccountIdstring required -
importIdstring required -
platformstring requiredOne of:FACEBOOKINSTAGRAMLINKEDINYOUTUBETIKTOKREDDITTHREADSMASTODONBLUESKYTWITTER -
externalIdstring required -
externalParentIdstring nullable -
externalPostIdstring nullable -
authorNamestring nullable -
authorExternalIdstring nullable -
authorProfileUrlstring nullable -
authorAvatarUrlstring nullable -
textstring nullable -
likesCountnumber required -
repliesCountnumber required -
platformDataobject default {}23 fields
-
canDeleteboolean nullable -
canHideboolean nullable -
canLikeboolean nullable -
canModerateboolean nullable -
hiddenboolean nullable -
likedByMeboolean nullable -
likedByAutomationboolean nullable -
reactionsCountnumber nullable -
reactionTypestring nullableOne of:LIKELOVEWOWHAHASADANGRY -
ownerboolean nullable -
hideStatusstring nullable -
moderationStatusstring nullable -
approvalStatusstring nullable -
statusstring nullable -
attachmentTypestring nullable -
attachmentUrlstring nullable -
cidstring nullable -
originstring nullableOne of:platformbundle -
sourcestring nullable -
mediaProductTypestring nullable -
bundleCommentIdstring nullable -
displayStatestring nullableOne of:activethread_deletedplatform_missing -
disabledReasonstring nullable
-
-
publishedAtstring nullable date-time -
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
-
-
totalnumber required
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/import/comments/{commentId}/action Run an action on a fetched comment
comment.importActionFetchedComment · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
commentId required | path | string |
Request body application/json
-
teamIdstring required -
actionstring requiredOne of:DELETEHIDEUNHIDELIKEUNLIKEAPPROVEREJECT -
reasonstring max length 500 -
banAuthorboolean
Example
curl -X POST "https://api.siaran.my/api/v1/comment/import/comments/COMMENTID/action" \
-H "x-api-key: $SIAR_API_KEY" \
-H "content-type: application/json" \
-d '{
"teamId": "TEAM_ID",
"action": "DELETE"
}' Response 200
2 top-level fields
-
successboolean required -
itemobject required23 fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
postIdstring nullable -
importedPostIdstring nullable -
socialAccountIdstring required -
importIdstring required -
platformstring requiredOne of:FACEBOOKINSTAGRAMLINKEDINYOUTUBETIKTOKREDDITTHREADSMASTODONBLUESKYTWITTER -
externalIdstring required -
externalParentIdstring nullable -
externalPostIdstring nullable -
authorNamestring nullable -
authorExternalIdstring nullable -
authorProfileUrlstring nullable -
authorAvatarUrlstring nullable -
textstring nullable -
likesCountnumber required -
repliesCountnumber required -
platformDataobject default {}23 fields
-
canDeleteboolean nullable -
canHideboolean nullable -
canLikeboolean nullable -
canModerateboolean nullable -
hiddenboolean nullable -
likedByMeboolean nullable -
likedByAutomationboolean nullable -
reactionsCountnumber nullable -
reactionTypestring nullableOne of:LIKELOVEWOWHAHASADANGRY -
ownerboolean nullable -
hideStatusstring nullable -
moderationStatusstring nullable -
approvalStatusstring nullable -
statusstring nullable -
attachmentTypestring nullable -
attachmentUrlstring nullable -
cidstring nullable -
originstring nullableOne of:platformbundle -
sourcestring nullable -
mediaProductTypestring nullable -
bundleCommentIdstring nullable -
displayStatestring nullableOne of:activethread_deletedplatform_missing -
disabledReasonstring nullable
-
-
publishedAtstring nullable date-time -
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
-
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/import/{importId} Get comment import by ID
comment.importGetById · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
importId required | path | string |
Example
curl -X GET "https://api.siaran.my/api/v1/comment/import/IMPORTID" \
-H "x-api-key: $SIAR_API_KEY" Response 200
15 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
socialAccountIdstring required -
postIdstring nullable -
importedPostIdstring nullable -
platformstring requiredOne of:FACEBOOKINSTAGRAMLINKEDINYOUTUBETIKTOKREDDITTHREADSMASTODONBLUESKYTWITTER -
statusstring requiredOne of:PENDINGFETCHINGRETRYINGCOMPLETEDSKIPPEDFAILEDRATE_LIMITED -
commentsImportednumber required -
errorstring nullable -
rateLimitResetAtstring nullable date-time -
startedAtstring nullable date-time -
completedAtstring nullable date-time -
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/{id} Get comment
comment.get · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id required | path | string |
Example
curl -X GET "https://api.siaran.my/api/v1/comment/ID" \
-H "x-api-key: $SIAR_API_KEY" Response 200
19 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
internalPostIdstring nullable -
importedPostIdstring nullable -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
titlestring nullable -
postDatestring nullable date-time -
postedDatestring nullable date-time -
statusstring requiredOne of:DRAFTSCHEDULEDPOSTEDERRORDELETEDPROCESSINGRETRYING -
dataobject required12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
errorstring nullable -
errorsobject nullable12 fields
-
TWITTERstring nullable -
FACEBOOKstring nullable -
INSTAGRAMstring nullable -
TIKTOKstring nullable -
LINKEDINstring nullable -
REDDITstring nullable -
YOUTUBEstring nullable -
MASTODONstring nullable -
THREADSstring nullable -
DISCORDstring nullable -
SLACKstring nullable -
BLUESKYstring nullable
-
-
errorsVerboseobject nullable12 fields
-
TWITTERobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
FACEBOOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
INSTAGRAMobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
TIKTOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
LINKEDINobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
REDDITobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
YOUTUBEobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
MASTODONobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
THREADSobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
DISCORDobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
SLACKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
BLUESKYobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
-
externalDataobject nullable12 fields
-
TWITTERobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
FACEBOOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
INSTAGRAMobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
TIKTOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
LINKEDINobject nullable3 fields
-
idstring nullable -
commentUrnstring nullable -
permalinkstring nullable
-
-
REDDITobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
YOUTUBEobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
MASTODONobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
THREADSobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
DISCORDobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
SLACKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
BLUESKYobject nullable5 fields
-
idstring nullable -
uristring nullable -
cidstring nullable -
permalinkstring nullable -
didstring nullable
-
-
-
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/{id} Update comment
comment.update · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id required | path | string |
Request body application/json
-
titlestring min length 1 -
internalPostIdstring -
importedPostIdstring -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
postDatestring -
statusstringOne of:DRAFTSCHEDULED -
socialAccountTypesstring[] min 1 itemsOne of:TIKTOKYOUTUBEINSTAGRAMFACEBOOKTWITTERTHREADSLINKEDINREDDITMASTODONDISCORDSLACKBLUESKY -
dataobject12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
textstring min length 1max length 10,000
Example
curl -X PATCH "https://api.siaran.my/api/v1/comment/ID" \
-H "x-api-key: $SIAR_API_KEY" \
-H "content-type: application/json" \
-d '{
"title": "Hello from Siar",
"internalPostId": "INTERNALPOST_ID",
"importedPostId": "IMPORTEDPOST_ID"
}' Response 200
19 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
internalPostIdstring nullable -
importedPostIdstring nullable -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
titlestring nullable -
postDatestring nullable date-time -
postedDatestring nullable date-time -
statusstring requiredOne of:DRAFTSCHEDULEDPOSTEDERRORDELETEDPROCESSINGRETRYING -
dataobject required12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
errorstring nullable -
errorsobject nullable12 fields
-
TWITTERstring nullable -
FACEBOOKstring nullable -
INSTAGRAMstring nullable -
TIKTOKstring nullable -
LINKEDINstring nullable -
REDDITstring nullable -
YOUTUBEstring nullable -
MASTODONstring nullable -
THREADSstring nullable -
DISCORDstring nullable -
SLACKstring nullable -
BLUESKYstring nullable
-
-
errorsVerboseobject nullable12 fields
-
TWITTERobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
FACEBOOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
INSTAGRAMobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
TIKTOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
LINKEDINobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
REDDITobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
YOUTUBEobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
MASTODONobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
THREADSobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
DISCORDobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
SLACKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
BLUESKYobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
-
externalDataobject nullable12 fields
-
TWITTERobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
FACEBOOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
INSTAGRAMobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
TIKTOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
LINKEDINobject nullable3 fields
-
idstring nullable -
commentUrnstring nullable -
permalinkstring nullable
-
-
REDDITobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
YOUTUBEobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
MASTODONobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
THREADSobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
DISCORDobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
SLACKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
BLUESKYobject nullable5 fields
-
idstring nullable -
uristring nullable -
cidstring nullable -
permalinkstring nullable -
didstring nullable
-
-
-
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/{id} Delete comment
comment.delete · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id required | path | string |
Example
curl -X DELETE "https://api.siaran.my/api/v1/comment/ID" \
-H "x-api-key: $SIAR_API_KEY" Response 200
19 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
internalPostIdstring nullable -
importedPostIdstring nullable -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
titlestring nullable -
postDatestring nullable date-time -
postedDatestring nullable date-time -
statusstring requiredOne of:DRAFTSCHEDULEDPOSTEDERRORDELETEDPROCESSINGRETRYING -
dataobject required12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
errorstring nullable -
errorsobject nullable12 fields
-
TWITTERstring nullable -
FACEBOOKstring nullable -
INSTAGRAMstring nullable -
TIKTOKstring nullable -
LINKEDINstring nullable -
REDDITstring nullable -
YOUTUBEstring nullable -
MASTODONstring nullable -
THREADSstring nullable -
DISCORDstring nullable -
SLACKstring nullable -
BLUESKYstring nullable
-
-
errorsVerboseobject nullable12 fields
-
TWITTERobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
FACEBOOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
INSTAGRAMobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
TIKTOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
LINKEDINobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
REDDITobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
YOUTUBEobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
MASTODONobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
THREADSobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
DISCORDobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
SLACKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
BLUESKYobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
-
externalDataobject nullable12 fields
-
TWITTERobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
FACEBOOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
INSTAGRAMobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
TIKTOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
LINKEDINobject nullable3 fields
-
idstring nullable -
commentUrnstring nullable -
permalinkstring nullable
-
-
REDDITobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
YOUTUBEobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
MASTODONobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
THREADSobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
DISCORDobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
SLACKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
BLUESKYobject nullable5 fields
-
idstring nullable -
uristring nullable -
cidstring nullable -
permalinkstring nullable -
didstring nullable
-
-
-
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment Get comment list
comment.getList · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
teamId required | query | string | |
postId | query | string | |
importedPostId | query | string | |
status | query | string | One of DRAFT, SCHEDULED, POSTED, ERROR, DELETED, PROCESSING, RETRYING |
orderBy | query | string | One of createdAt, updatedAt, deletedAt |
order | query | string | One of ASC, DESC |
q | query | string | |
platforms | query | string[] | nullable |
offset | query | number | default 0 · nullable |
limit | query | number | default 10 · nullable |
Example
curl -X GET "https://api.siaran.my/api/v1/comment/?teamId=TEAM_ID" \
-H "x-api-key: $SIAR_API_KEY" Response 200
2 top-level fields
-
itemsobject[] required19 fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
internalPostIdstring nullable -
importedPostIdstring nullable -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
titlestring nullable -
postDatestring nullable date-time -
postedDatestring nullable date-time -
statusstring requiredOne of:DRAFTSCHEDULEDPOSTEDERRORDELETEDPROCESSINGRETRYING -
dataobject required12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
errorstring nullable -
errorsobject nullable12 fields
-
TWITTERstring nullable -
FACEBOOKstring nullable -
INSTAGRAMstring nullable -
TIKTOKstring nullable -
LINKEDINstring nullable -
REDDITstring nullable -
YOUTUBEstring nullable -
MASTODONstring nullable -
THREADSstring nullable -
DISCORDstring nullable -
SLACKstring nullable -
BLUESKYstring nullable
-
-
errorsVerboseobject nullable12 fields
-
TWITTERobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
FACEBOOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
INSTAGRAMobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
TIKTOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
LINKEDINobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
REDDITobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
YOUTUBEobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
MASTODONobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
THREADSobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
DISCORDobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
SLACKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
BLUESKYobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
-
externalDataobject nullable12 fields
-
TWITTERobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
FACEBOOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
INSTAGRAMobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
TIKTOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
LINKEDINobject nullable3 fields
-
idstring nullable -
commentUrnstring nullable -
permalinkstring nullable
-
-
REDDITobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
YOUTUBEobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
MASTODONobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
THREADSobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
DISCORDobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
SLACKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
BLUESKYobject nullable5 fields
-
idstring nullable -
uristring nullable -
cidstring nullable -
permalinkstring nullable -
didstring nullable
-
-
-
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
-
-
totalnumber required
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment Create comment
comment.create · requires x-api-key
Request body application/json
-
teamIdstring required -
titlestring min length 1 -
internalPostIdstring -
importedPostIdstring -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
postDatestring -
statusstringOne of:DRAFTSCHEDULED -
socialAccountTypesstring[] min 1 itemsOne of:TIKTOKYOUTUBEINSTAGRAMFACEBOOKTWITTERTHREADSLINKEDINREDDITMASTODONDISCORDSLACKBLUESKY -
dataobject12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
textstring min length 1max length 10,000
Example
curl -X POST "https://api.siaran.my/api/v1/comment/" \
-H "x-api-key: $SIAR_API_KEY" \
-H "content-type: application/json" \
-d '{
"teamId": "TEAM_ID"
}' Response 200
19 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
internalPostIdstring nullable -
importedPostIdstring nullable -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
titlestring nullable -
postDatestring nullable date-time -
postedDatestring nullable date-time -
statusstring requiredOne of:DRAFTSCHEDULEDPOSTEDERRORDELETEDPROCESSINGRETRYING -
dataobject required12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
errorstring nullable -
errorsobject nullable12 fields
-
TWITTERstring nullable -
FACEBOOKstring nullable -
INSTAGRAMstring nullable -
TIKTOKstring nullable -
LINKEDINstring nullable -
REDDITstring nullable -
YOUTUBEstring nullable -
MASTODONstring nullable -
THREADSstring nullable -
DISCORDstring nullable -
SLACKstring nullable -
BLUESKYstring nullable
-
-
errorsVerboseobject nullable12 fields
-
TWITTERobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
FACEBOOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
INSTAGRAMobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
TIKTOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
LINKEDINobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
REDDITobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
YOUTUBEobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
MASTODONobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
THREADSobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
DISCORDobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
SLACKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
BLUESKYobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
-
externalDataobject nullable12 fields
-
TWITTERobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
FACEBOOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
INSTAGRAMobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
TIKTOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
LINKEDINobject nullable3 fields
-
idstring nullable -
commentUrnstring nullable -
permalinkstring nullable
-
-
REDDITobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
YOUTUBEobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
MASTODONobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
THREADSobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
DISCORDobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
SLACKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
BLUESKYobject nullable5 fields
-
idstring nullable -
uristring nullable -
cidstring nullable -
permalinkstring nullable -
didstring nullable
-
-
-
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error
/api/v1/comment/{id}/retry Retry comment
comment.retry · requires x-api-key
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id required | path | string |
Example
curl -X POST "https://api.siaran.my/api/v1/comment/ID/retry" \
-H "x-api-key: $SIAR_API_KEY" Response 200
19 top-level fields
-
idstring required -
teamIdstring required -
organizationIdstring nullable -
internalPostIdstring nullable -
importedPostIdstring nullable -
internalParentCommentIdstring nullable -
fetchedParentCommentIdstring nullable -
titlestring nullable -
postDatestring nullable date-time -
postedDatestring nullable date-time -
statusstring requiredOne of:DRAFTSCHEDULEDPOSTEDERRORDELETEDPROCESSINGRETRYING -
dataobject required12 fields
-
TWITTERobject nullable1 field
-
textstring nullable
-
-
FACEBOOKobject nullable1 field
-
textstring nullable
-
-
INSTAGRAMobject nullable1 field
-
textstring nullable
-
-
THREADSobject nullable1 field
-
textstring nullable
-
-
TIKTOKobject nullable1 field
-
textstring nullable
-
-
LINKEDINobject nullable1 field
-
textstring nullable
-
-
YOUTUBEobject nullable1 field
-
textstring nullable
-
-
REDDITobject nullable1 field
-
textstring nullable
-
-
MASTODONobject nullable1 field
-
textstring nullable
-
-
DISCORDobject nullable1 field
-
textstring nullable
-
-
SLACKobject nullable1 field
-
textstring nullable
-
-
BLUESKYobject nullable1 field
-
textstring nullable
-
-
-
errorstring nullable -
errorsobject nullable12 fields
-
TWITTERstring nullable -
FACEBOOKstring nullable -
INSTAGRAMstring nullable -
TIKTOKstring nullable -
LINKEDINstring nullable -
REDDITstring nullable -
YOUTUBEstring nullable -
MASTODONstring nullable -
THREADSstring nullable -
DISCORDstring nullable -
SLACKstring nullable -
BLUESKYstring nullable
-
-
errorsVerboseobject nullable12 fields
-
TWITTERobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
FACEBOOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
INSTAGRAMobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
TIKTOKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
LINKEDINobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
REDDITobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
YOUTUBEobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
MASTODONobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
THREADSobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
DISCORDobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
SLACKobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
BLUESKYobject nullable7 fields
-
codestring nullable -
errorMessagestring nullable -
isTransientboolean nullable -
retryabilitystring nullableOne of:retryablenon_retryableunknown -
httpStatusnumber nullable -
metaany nullable -
userFacingMessagestring nullable
-
-
-
externalDataobject nullable12 fields
-
TWITTERobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
FACEBOOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
INSTAGRAMobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
TIKTOKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
LINKEDINobject nullable3 fields
-
idstring nullable -
commentUrnstring nullable -
permalinkstring nullable
-
-
REDDITobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
YOUTUBEobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
MASTODONobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
THREADSobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
DISCORDobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
SLACKobject nullable2 fields
-
idstring nullable -
permalinkstring nullable
-
-
BLUESKYobject nullable5 fields
-
idstring nullable -
uristring nullable -
cidstring nullable -
permalinkstring nullable -
didstring nullable
-
-
-
createdAtstring required nullable date-time -
updatedAtstring required nullable date-time -
deletedAtstring nullable date-time
Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error