Blotato
App · 20 actions
Blotato publishing, account data, comments, schedules and video templates.
Actions
| Action | What it does |
|---|---|
| Create video | Start a video creation using a template. |
| Delete schedule | Delete schedule. |
| Get comment | Get comment. |
| Get current user | Get current user. |
| Get post analytics | Get post analytics. |
| Get post submission | Get post submission. |
| Get published post | Get published post. |
| Get schedule | Get schedule. |
| Get usage | Get usage. |
| Get video creation | Get video creation. |
| List accounts | List accounts. |
| List comments | List comments. |
| List posts | List posts. |
| List published posts | List published posts. |
| List schedules | List schedules. |
| List subaccounts | List subaccounts. |
| List video templates | List video templates. |
| Publish post | Submit a post for publishing or scheduling. |
| Update schedule | Update schedule. |
| Upload media | Upload media. |
Create video
Start a video creation using a template. Use Get video creation to retrieve its status and result.
Inputs
- Template
templateIdtextRequired - Template Id.
- Inputs
inputsobjectRequired - Inputs.
- Prompt
prompttext - Prompt.
- Is Draft
isDrafttrue/false - Is Draft.
- Render
rendertrue/falseRequired - Render.
- Title
titletext - Title.
- Use Brand Kit
useBrandKittrue/false - Use Brand Kit.
- Brand Id
brandIdtext - Brand Id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"item": {
"id": "example",
"status": "queueing"
}
}
}Delete schedule
Delete schedule.
Inputs
- Id
idtextRequired - The ID of the schedule to delete.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Get comment
Get comment.
Inputs
- Comment Id
commentIdtextRequired - Blotato id of the comment to fetch.
Outputs
dataobject- Api result.
Example output
{
"data": {
"accountId": "example",
"author": {
"name": "example",
"username": "example"
},
"authorId": "example",
"createdAt": "example",
"errorCode": 1,
"errorMessage": "example",
"id": "example",
"isAuthor": false,
"parentCommentId": "example",
"platform": "facebook",
"platformCommentId": "example",
"platformPostId": "example",
"postId": "example",
"status": "deleted",
"text": "example"
}
}Get current user
Get current user.
Inputs
None.
Outputs
dataobject- Current user information
Example output
{
"data": {
"id": "example",
"subscriptionPlan": "starter",
"subscriptionStatus": "example"
}
}Get post analytics
Get post analytics.
Inputs
- Id
idtextRequired - The id of the published post.
Outputs
dataobject- Api result.
Example output
{
"data": {
"history": [],
"lastError": "example",
"lastFetchedAt": "example",
"metrics": {
"blueskyQuotesCount": "example",
"blueskyRepostsCount": "example",
"clicksCount": "example",
"commentsCount": "example",
"facebookBlueReelsPlaysCount": "example",
"facebookFbReelsReplaysCount": "example",
"facebookFbReelsTotalPlaysCount": "example",
"facebookPostMediaViewsCount": "example",
"facebookPostMediaViewsUniqueCount": "example",
"facebookPostReactionsByType": {},
"facebookPostVideoFollowersCount": "example",
"facebookPostVideoLikesByReactionType": {},
"facebookPostVideoSocialActionsByType": {},
"facebookPostVideoViewTimeMsSum": "example",
"facebookPostVideoWatchTimeMsAvg": "example",
"facebookTotalVideoCompleteViewsAutoplayedCount": "example",
"facebookTotalVideoCompleteViewsClickedToPlayCount": "example",
"facebookTotalVideoCompleteViewsCount": "example",
"facebookTotalVideoCompleteViewsOrganicCount": "example",
"facebookTotalVideoCompleteViewsOrganicUniqueCount": "example",
"facebookTotalVideoCompleteViewsPaidCount": "example",
"facebookTotalVideoCompleteViewsPaidUniqueCount": "example",
"facebookTotalVideoCompleteViewsUniqueCount": "example",
"facebookTotalVideoReactionsByType": {},
"facebookTotalVideoStoriesByActionType": {},
"facebookTotalVideoViewTimeMsByAgeBucketAndGender": {},
"facebookTotalVideoViewTimeMsByRegionId": {},
"facebookTotalVideoViewTimeMsSum": "example",
"facebookTotalVideoViewTimeOrganicMsSum": "example",
"facebookTotalVideoViewTimePaidMsSum": "example",
"facebookTotalVideoViews10sAutoplayedCount": "example",
"facebookTotalVideoViews10sClickedToPlayCount": "example",
"facebookTotalVideoViews10sCount": "example",
"facebookTotalVideoViews10sOrganicCount": "example",
"facebookTotalVideoViews10sPaidCount": "example",
"facebookTotalVideoViews10sSoundOnCount": "example",
"facebookTotalVideoViews10sUniqueCount": "example",
"facebookTotalVideoViews15sCount": "example",
"facebookTotalVideoViews60sExcludesShorterCount": "example",
"facebookTotalVideoViewsAutoplayedCount": "example",
"facebookTotalVideoViewsByDistributionType": {},
"facebookTotalVideoViewsClickedToPlayCount": "example",
"facebookTotalVideoViewsCount": "example",
"facebookTotalVideoViewsSoundOnCount": "example",
"facebookTotalVideoViewsUniqueCount": "example",
"facebookTotalVideoWatchTimeMsAvg": "example",
"followsCount": "example",
"impressionsCount": "example",
"interactionsSum": "example",
"likesCount": "example",
"linkedinFirstLevelCommentsCount": "example",
"linkedinReactionsByType": {},
"navigationsCount": "example",
"pinterestPinClicksCount": "example",
"pinterestReactionsCount": "example",
"pinterestSaveRate": 1.0,
"pinterestVideo10sViewsCount": "example",
"pinterestVideoMrcViewsCount": "example",
"pinterestVideoP95ViewsCount": "example",
"pinterestVideoV50WatchTimeMsSum": "example",
"playsCount": "example",
"profileActivityCount": "example",
"profileVisitsCount": "example",
"reachCount": "example",
"repliesCount": "example",
"savesCount": "example",
"sharesCount": "example",
"threadsQuotesCount": "example",
"threadsRepostsCount": "example",
"twitterPerMediaVideoPlayback25Count": [],
"twitterPerMediaVideoPlayback50Count": [],
"twitterPerMediaVideoPlayback75Count": [],
"twitterPerMediaVideoPlaybackCompleteCount": [],
"twitterPerMediaVideoPlaybackStartCount": [],
"twitterPerMediaVideoViewsCount": [],
"twitterQuotesCount": "example",
"twitterRetweetsCount": "example",
"viewTimeMsSum": "example",
"viewsCount": "example",
"watchTimeMsAvg": "example",
"youtubeAnnotationClickThroughRate": 1.0,
"youtubeAnnotationClickableImpressionsCount": "example",
"youtubeAnnotationClicksCount": "example",
"youtubeAnnotationClosableImpressionsCount": "example",
"youtubeAnnotationCloseRate": 1.0,
"youtubeAnnotationClosesCount": "example",
"youtubeAnnotationImpressionsCount": "example",
"youtubeAverageViewPercentage": 1.0,
"youtubeCardClickRate": 1.0,
"youtubeCardClicksCount": "example",
"youtubeCardImpressionsCount": "example",
"youtubeCardTeaserClickRate": 1.0,
"youtubeCardTeaserClicksCount": "example",
"youtubeCardTeaserImpressionsCount": "example",
"youtubeDislikesCount": "example",
"youtubeEngagedViewsCount": "example",
"youtubeRedViewTimeMsSum": "example",
"youtubeRedViewsCount": "example",
"youtubeSubscribersLostCount": "example",
"youtubeVideosAddedToPlaylistsCount": "example",
"youtubeVideosRemovedFromPlaylistsCount": "example"
},
"platform": "twitter",
"publishedPostId": "example"
}
}Get post submission
Get post submission.
Inputs
- Post Submission Id
postSubmissionIdtextRequired - The ID of the post submission to check.
Outputs
dataobject- Api result.
Example output
{
"data": {
"errorMessage": "example",
"postSubmissionId": "example",
"publicUrl": "example",
"scheduledTime": "example",
"status": "in-progress"
}
}Get published post
Get published post.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"publishedPost": {
"content": "example",
"createdAt": "example",
"id": "example",
"mediaUrls": [],
"platform": "twitter",
"postUrl": "example",
"rawPost": {
"accountId": "example",
"content": {
"additionalPosts": [],
"mediaUrls": [],
"platform": "twitter",
"text": "example"
},
"target": {
"targetType": "webhook",
"url": "example"
}
}
}
}
}Get schedule
Get schedule.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"schedule": {
"account": {
"id": "example",
"name": "example",
"profileImageUrl": "example",
"subId": "example",
"subaccountId": "example",
"subaccountName": "example",
"username": "example"
},
"draft": {
"accountId": "example",
"content": {
"additionalPosts": [],
"mediaUrls": [],
"platform": "twitter",
"text": "example"
},
"target": {
"targetType": "webhook",
"url": "example"
}
},
"id": "example",
"scheduledAt": "example"
}
}
}Get usage
Get usage.
Inputs
None.
Outputs
dataobject- Api result.
Example output
{
"data": {
"accounts": 1,
"contacts": 1,
"contactsLimit": "unlimited"
}
}Get video creation
Get video creation.
Inputs
- Id
idtextRequired - Video ID
Outputs
dataobject- Api result.
Example output
{
"data": {
"item": {
"createdAt": "example",
"error": "example",
"errorMetadata": {
"creditsRemaining": 1.0,
"creditsRequired": 1.0,
"numAiOverlays": 1.0,
"numDraftOverlays": 1.0
},
"id": "example",
"imageUrls": [],
"mediaUrl": "example",
"status": "queueing"
}
}
}List accounts
List accounts.
Inputs
- Platform
platformtext - Social media platformOne of:
twitter,instagram,linkedin,facebook,tiktok,pinterest,threads,bluesky,youtube,slack,other.
Outputs
dataobject- Api result.
Example output
{
"data": {
"items": []
}
}List comments
List comments.
Inputs
- Limit
limitnumber - Maximum number of comments to return. Defaults to 50.From 1 to 250.
- Cursor
cursortext - Opaque cursor returned by a previous call. Pass it to fetch the next page.
- Platform
platformlist - Filter comments by platform. Pass multiple values to include any of them.One or more of:
facebook,instagram. - Account
accountIdtext - Filter to comments belonging to a single connected account.
- Parent Comment Id
parentCommentIdtext - Filter to direct replies to a single comment.
- Post Id
postIdtext - Filter to comments on a single Blotato-published post. Accepts either the published post ID or the post submission ID returned when the post was published.
- Since
sincedate and time - Only include comments created on or after this ISO 8601 timestamp. Omit to apply no lower bound.
- Until
untildate and time - Only include comments created on or before this ISO 8601 timestamp. Omit to apply no upper bound.
Outputs
dataobject- Api result.
Example output
{
"data": {
"cursor": "example",
"items": []
}
}List posts
List posts.
Inputs
- Since
sincedate and time - Only include posts whose post time is on or after this ISO 8601 timestamp. Defaults to 7 days ago.
- Until
untildate and time - Only include posts whose post time is on or before this ISO 8601 timestamp. Defaults to 7 days from now.
- Limit
limitnumber - Maximum number of posts to return. Defaults to 50.From 1 to 250.
- Cursor
cursortext - Opaque cursor returned by a previous call. Pass it to fetch the next page.
- Status
statuslist - Filter posts by status. Pass multiple values to include any of them. Omit to include all statuses.One or more of:
scheduled,published,failed. - Platform
platformlist - Filter posts by social media platform. Pass multiple values to include any of them. Omit to include all platforms.One or more of:
twitter,instagram,linkedin,facebook,tiktok,pinterest,threads,bluesky,youtube,slack,other. - Source
sourcetext - Which published posts to include: 'blotato' (default) returns only posts published through Blotato; 'all' also includes any externally-published posts that were brought into Blotato.One of:
blotato,all.
Outputs
dataobject- Api result.
Example output
{
"data": {
"cursor": "example",
"items": []
}
}List published posts
List published posts.
Inputs
- Query
querytext - Query.
- Platform
platformtext - Platform.
- Account Id
accountIdtext - Account Id.
- Sort By
sortBytext - Sort By.One of:
newest,oldest. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
Outputs
dataobject- Api result.
Example output
{
"data": {
"count": 1,
"items": []
}
}List schedules
List schedules.
Inputs
- Limit
limitnumber - Limit.
- Cursor
cursortext - Cursor.
Outputs
dataobject- Api result.
Example output
{
"data": {
"count": "example",
"cursor": "example",
"items": []
}
}List subaccounts
List subaccounts.
Inputs
- Account
accountIdtextRequired - Account Id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"items": []
}
}List video templates
List video templates.
Inputs
- Fields
fieldstext - Comma separated list of fields to include. If provided, only these fields will be included in the response for each template. If omitted, only id, title, and description are included. Id is always included in the response.
- Search
searchtext - Search regex term to filter templates by title or description. Has no effect if "id" is also provided.
- Id
idtext - If provided, only the template with this ID will be returned.
Outputs
dataobject- Api result.
Example output
{
"data": {
"items": []
}
}Publish post
Submit a post for publishing or scheduling. Returns a submission ID; use Get post submission to verify its final status.
Inputs
- Account
account_idtextRequired - Account id.
- Platform
platformtextRequired - Platform.One of:
twitter,instagram,linkedin,facebook,tiktok,pinterest,threads,bluesky,youtube,slack,other. - Text
texttextRequired - Text.
- Media urls
media_urlslist - Media urls.
- Target options
target_optionsobject - Target options.
- Scheduled time
scheduled_timedate and time - Scheduled time.
Outputs
dataobject- Submitted
Example output
{
"data": {
"postSubmissionId": "example",
"scheduledTime": "example"
}
}Update schedule
Update schedule.
Inputs
- Id
idtextRequired - The ID of the schedule to update.
- Patch
patchobjectRequired - The fields to update in the schedule.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Upload media
Upload media.
Inputs
- Url
urltextRequired - The URL of the media to upload.
Outputs
dataobject- Api result.
Example output
{
"data": {
"id": "example",
"url": "example"
}
}