Metricool

App · 25 actions

Read social analytics and calendars, and manage scheduled posts and post notes.

Actions

ActionWhat it does
Creates a new scheduled postCreate a new scheduled post.
Delete /v2/scheduler/posts/{postId}/notes/{noteId}Delete /v2/scheduler/posts/{postId}/notes/{noteId}.
Delete scheduler/posts/{id}Delete scheduler/posts/{id}.
Find bluesky accountsFind bluesky accounts.
Find youtube accountsFind youtube accounts.
Get /v2/analytics/posts/pinterestGet /v2/analytics/posts/pinterest.
Get /v2/scheduler/posts/{postId}/notesGet /v2/scheduler/posts/{postId}/notes.
Get a scheduled post by idGet a scheduled post by id.
Get all system calendar data stored in database, only publicGet all system calendar data stored in database, only public.
Get analyticsGet analytics.
Get analytics/posts/instagramGet analytics/posts/instagram.
Get calendar reportGet calendar report.
Get calendar with it events in time periodGet calendar with it events in time period.
Get campaign analyticsGet campaign analytics.
Get campaign timelineGet campaign timeline.
List bluesky eventsList bluesky events.
List brand postsList brand posts.
List campaign dashboardsList campaign dashboards.
List google ads campaignsList google ads campaigns.
List tiktok ads campaignsList tiktok ads campaigns.
Post /v2/scheduler/posts/{postId}/notesPost /v2/scheduler/posts/{postId}/notes.
Reschedule postReschedule post.
Returns best time values to publishGet best time values to publish.
Returns the list of brands of your accountGet the list of brands of your Metricool account.
Returns the list of TikTok posts created during a period of timeGet the list of TikTok posts created during a period of time.

Creates a new scheduled post

Create a new scheduled post.

Inputs

Job IDjob_idtext
Optional job identifier
Ididnumber
id.
Publication timepublication_timedate and timeRequired
When to publish. Converted to UTC.
Publication timezonepublication_timezonetext
Use UTC with the publication time picker.One of: UTC.
TexttexttextRequired
text.
First comment textfirst_comment_texttext
firstCommentText.
ProvidersproviderslistRequired
providers.
Mediamedialist
media.
Auto publishauto_publishtrue/false
autoPublish.
Save external media filessave_external_media_filestrue/false
saveExternalMediaFiles.
Media alt textmedia_alt_textlist
mediaAltText.
Shortenershortenertrue/false
shortener.
Draftdrafttrue/false
draft.
Locationlocationobject
Additional structured location. Use the documented fields.
Video cover millisecondsvideo_cover_millisecondsnumber
videoCoverMilliseconds.
Video thumbnail urlvideo_thumbnail_urltext
videoThumbnailUrl.
Parent IDparent_idnumber
parentId.
Twitter datatwitter_dataobject
Additional structured twitter data. Use the documented fields.
Facebook datafacebook_dataobject
Additional structured facebook data. Use the documented fields.
Smart link datasmart_link_dataobject
Additional structured smart link data. Use the documented fields.
Instagram datainstagram_dataobject
Additional structured instagram data. Use the documented fields.
Pinterest datapinterest_dataobject
Additional structured pinterest data. Use the documented fields.
Youtube datayoutube_dataobject
Additional structured youtube data. Use the documented fields.
Tiktok datatiktok_dataobject
Additional structured tiktok data. Use the documented fields.
Linkedin datalinkedin_dataobject
Additional structured linkedin data. Use the documented fields.
Autolist dataautolist_dataobject
Additional structured autolist data. Use the documented fields.
Brand namebrand_nametext
brandName.
Target brand IDtarget_brand_idnumber
targetBrandId.
Gmb datagmb_dataobject
Additional structured gmb data. Use the documented fields.
Descendantsdescendantslist
descendants.
Notesnoteslist
notes.
Has not read noteshas_not_read_notestrue/false
hasNotReadNotes.
Uuiduuidtext
uuid.
Copied fromcopied_fromtext
copiedFrom.
Creator user mailcreator_user_mailtext
creatorUserMail.
Creator user IDcreator_user_idnumber
creatorUserId.
Creator agency user mailcreator_agency_user_mailtext
creatorAgencyUserMail.
Creator agency IDcreator_agency_idnumber
creatorAgencyId.
Creator agency user IDcreator_agency_user_idnumber
creatorAgencyUserId.
Post approval datapost_approval_dataobject
Additional structured post approval data. Use the documented fields.
Threads datathreads_dataobject
Additional structured threads data. Use the documented fields.
Bluesky databluesky_dataobject
Additional structured bluesky data. Use the documented fields.
Library post IDlibrary_post_idnumber
libraryPostId.
Performance dashboard IDsperformance_dashboard_idslist
performanceDashboardIds.
Brand tag IDsbrand_tag_idslist
Ids of the brand tags to apply: absent keeps the current ones, empty removes them all, a list replaces them. Ids that are not live tags of the brand are ignored; at most 20.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": {
      "autoPublish": true,
      "autolistData": {
        "id": 1,
        "name": "example"
      },
      "blueskyData": {
        "postLanguages": []
      },
      "brandName": "example",
      "brandTagIds": [],
      "brandTags": [],
      "copiedFrom": "example",
      "creationDate": {
        "dateTime": "example",
        "timezone": "example"
      },
      "creatorAgencyId": 1,
      "creatorAgencyUserId": 1,
      "creatorAgencyUserMail": "example",
      "creatorUserId": 1,
      "creatorUserMail": "example",
      "descendants": [],
      "draft": true,
      "facebookData": {
        "boost": 1,
        "boostBeneficiary": "example",
        "boostPayer": "example",
        "title": "example",
        "type": "example"
      },
      "firstCommentText": "example",
      "gmbData": {
        "type": "example"
      },
      "hasNotReadNotes": true,
      "id": 1,
      "instagramData": {
        "audioConfiguration": {
          "audioId": "example",
          "audioType": "music",
          "audioVolume": 1,
          "coverArtworkUrl": "example",
          "displayArtist": "example",
          "durationMs": 1,
          "igUsername": "example",
          "title": "example",
          "videoVolume": 1
        },
        "audioName": "example",
        "autoPublish": true,
        "boost": 1,
        "boostBeneficiary": "example",
        "boostPayer": "example",
        "carouselProductTags": {},
        "carouselTags": {},
        "collaborators": [],
        "isAiGenerated": true,
        "productTags": [],
        "shareTrialAutomatically": true,
        "showReelOnFeed": true,
        "tags": [],
        "type": "example"
      },
      "libraryPostId": 1,
      "linkedinData": {
        "documentTitle": "example",
        "poll": {
          "options": [],
          "question": "example",
          "settings": {
            "duration": "example"
          }
        },
        "previewIncluded": true,
        "publishImagesAsPDF": true,
        "type": "example"
      },
      "location": {
        "deleted": true,
        "id": "example",
        "link": "example",
        "location": {
          "city": "example",
          "country": "example",
          "latitude": 1,
          "longitude": 1,
          "state": "example",
          "street": "example",
          "zip": "example"
        },
        "name": "example"
      },
      "media": [],
      "mediaAltText": [],
      "notes": [],
      "parentId": 1,
      "performanceDashboardIds": [],
      "pinterestData": {
        "boardId": "example",
        "isAiGenerated": true,
        "isAiGeneratedPerson": true,
        "pinLink": "example",
        "pinNewFormat": true,
        "pinTitle": "example"
      },
      "postApprovalData": {
        "anonymousReviewerLanguage": "example",
        "approvalCriteria": "example",
        "approvalEvents": [],
        "approvalStatus": "example",
        "saveData": true,
        "sendMailToReviewers": true
      },
      "providers": [],
      "publicationDate": {
        "dateTime": "example",
        "timezone": "example"
      },
      "saveExternalMediaFiles": true,
      "shortener": true,
      "smartLinkData": {
        "ids": [],
        "targetUrl": "example"
      },
      "targetBrandId": 1,
      "text": "example",
      "threadsData": {
        "allowedCountryCodes": [],
        "instagramStoryTheme": "example",
        "isSpoiler": true,
        "replyControl": "example",
        "shareAsInstagramStory": true,
        "type": "example"
      },
      "tiktokData": {
        "articleLink": {
          "title": "example",
          "url": "example"
        },
        "autoAddMusic": true,
        "commercialContentOwnBrand": true,
        "commercialContentThirdParty": true,
        "disableComment": true,
        "disableDuet": true,
        "disableStitch": true,
        "isAigc": true,
        "music": {
          "author": "example",
          "endMillis": 1,
          "musicId": "example",
          "originalVolume": 1,
          "previewUrl": "example",
          "soundVolume": 1,
          "startMillis": 1,
          "thumbnailUrl": "example",
          "title": "example"
        },
        "photoCoverIndex": 1,
        "privacyOption": "example",
        "title": "example"
      },
      "twitterData": {
        "isPollChild": true,
        "poll": {
          "options": [],
          "settings": {
            "durationMinutes": 1
          }
        },
        "replySettings": "example",
        "tags": [],
        "type": "example"
      },
      "uuid": "example",
      "videoCoverMilliseconds": 1,
      "videoThumbnailUrl": "example",
      "youtubeData": {
        "category": "example",
        "isAiGeneratedContent": true,
        "madeForKids": true,
        "notifySubscribers": true,
        "playlistId": "example",
        "privacy": "example",
        "tags": [],
        "title": "example",
        "type": "example"
      }
    },
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete /v2/scheduler/posts/{postId}/notes/{noteId}

Delete /v2/scheduler/posts/{postId}/notes/{noteId}.

Inputs

Post IDpost_idnumberRequired
postId.
Note IDnote_idnumberRequired
noteId.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": true,
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete scheduler/posts/{id}

Delete scheduler/posts/{id}.

Inputs

IdidnumberRequired
id of the scheduled post

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": true,
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Find bluesky accounts

Find bluesky accounts. Returns the full service response for the connected account.

Inputs

HandlehandletextRequired
handle.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Find youtube accounts

Find youtube accounts. Returns the full service response for the connected account.

Inputs

HandlehandletextRequired
handle.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get /v2/analytics/posts/pinterest

Get /v2/analytics/posts/pinterest. Returns the full service response for the connected account.

Inputs

Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
Tagstagslist
(Optional) Brand tag ids; keeps only the content having any of them.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get /v2/scheduler/posts/{postId}/notes

Get /v2/scheduler/posts/{postId}/notes. Returns the full service response for the connected account.

Inputs

Post IDpost_idnumberRequired
postId.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get a scheduled post by id

Get a scheduled post by id. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
id of the scheduled post.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": {
      "autoPublish": true,
      "autolistData": {
        "id": 1,
        "name": "example"
      },
      "blueskyData": {
        "postLanguages": []
      },
      "brandName": "example",
      "brandTagIds": [],
      "brandTags": [],
      "copiedFrom": "example",
      "creationDate": {
        "dateTime": "example",
        "timezone": "example"
      },
      "creatorAgencyId": 1,
      "creatorAgencyUserId": 1,
      "creatorAgencyUserMail": "example",
      "creatorUserId": 1,
      "creatorUserMail": "example",
      "descendants": [],
      "draft": true,
      "facebookData": {
        "boost": 1,
        "boostBeneficiary": "example",
        "boostPayer": "example",
        "title": "example",
        "type": "example"
      },
      "firstCommentText": "example",
      "gmbData": {
        "type": "example"
      },
      "hasNotReadNotes": true,
      "id": 1,
      "instagramData": {
        "audioConfiguration": {
          "audioId": "example",
          "audioType": "music",
          "audioVolume": 1,
          "coverArtworkUrl": "example",
          "displayArtist": "example",
          "durationMs": 1,
          "igUsername": "example",
          "title": "example",
          "videoVolume": 1
        },
        "audioName": "example",
        "autoPublish": true,
        "boost": 1,
        "boostBeneficiary": "example",
        "boostPayer": "example",
        "carouselProductTags": {},
        "carouselTags": {},
        "collaborators": [],
        "isAiGenerated": true,
        "productTags": [],
        "shareTrialAutomatically": true,
        "showReelOnFeed": true,
        "tags": [],
        "type": "example"
      },
      "libraryPostId": 1,
      "linkedinData": {
        "documentTitle": "example",
        "poll": {
          "options": [],
          "question": "example",
          "settings": {
            "duration": "example"
          }
        },
        "previewIncluded": true,
        "publishImagesAsPDF": true,
        "type": "example"
      },
      "location": {
        "deleted": true,
        "id": "example",
        "link": "example",
        "location": {
          "city": "example",
          "country": "example",
          "latitude": 1,
          "longitude": 1,
          "state": "example",
          "street": "example",
          "zip": "example"
        },
        "name": "example"
      },
      "media": [],
      "mediaAltText": [],
      "notes": [],
      "parentId": 1,
      "performanceDashboardIds": [],
      "pinterestData": {
        "boardId": "example",
        "isAiGenerated": true,
        "isAiGeneratedPerson": true,
        "pinLink": "example",
        "pinNewFormat": true,
        "pinTitle": "example"
      },
      "postApprovalData": {
        "anonymousReviewerLanguage": "example",
        "approvalCriteria": "example",
        "approvalEvents": [],
        "approvalStatus": "example",
        "saveData": true,
        "sendMailToReviewers": true
      },
      "providers": [],
      "publicationDate": {
        "dateTime": "example",
        "timezone": "example"
      },
      "saveExternalMediaFiles": true,
      "shortener": true,
      "smartLinkData": {
        "ids": [],
        "targetUrl": "example"
      },
      "targetBrandId": 1,
      "text": "example",
      "threadsData": {
        "allowedCountryCodes": [],
        "instagramStoryTheme": "example",
        "isSpoiler": true,
        "replyControl": "example",
        "shareAsInstagramStory": true,
        "type": "example"
      },
      "tiktokData": {
        "articleLink": {
          "title": "example",
          "url": "example"
        },
        "autoAddMusic": true,
        "commercialContentOwnBrand": true,
        "commercialContentThirdParty": true,
        "disableComment": true,
        "disableDuet": true,
        "disableStitch": true,
        "isAigc": true,
        "music": {
          "author": "example",
          "endMillis": 1,
          "musicId": "example",
          "originalVolume": 1,
          "previewUrl": "example",
          "soundVolume": 1,
          "startMillis": 1,
          "thumbnailUrl": "example",
          "title": "example"
        },
        "photoCoverIndex": 1,
        "privacyOption": "example",
        "title": "example"
      },
      "twitterData": {
        "isPollChild": true,
        "poll": {
          "options": [],
          "settings": {
            "durationMinutes": 1
          }
        },
        "replySettings": "example",
        "tags": [],
        "type": "example"
      },
      "uuid": "example",
      "videoCoverMilliseconds": 1,
      "videoThumbnailUrl": "example",
      "youtubeData": {
        "category": "example",
        "isAiGeneratedContent": true,
        "madeForKids": true,
        "notifySubscribers": true,
        "playlistId": "example",
        "privacy": "example",
        "tags": [],
        "title": "example",
        "type": "example"
      }
    },
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get all system calendar data stored in database, only public

Get all system calendar data stored in database, only public. Returns the full service response for the connected account.

Inputs

Languagelanguagetext
calendar language

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get analytics

Get analytics. Returns the full service response for the connected account.

Inputs

NetworknetworktextRequired
network.
MetricmetrictextRequired
metric.
Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
Subjectsubjecttext
subject.
Scopescopetext
scope.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": 1,
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get analytics/posts/instagram

Get analytics/posts/instagram. Returns the full service response for the connected account.

Inputs

Fromfrom_valuedate and timeRequired
From Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
Totodate and timeRequired
To Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
Timezonetimezonetext
(Optional) The timezone used for the date range to search. ('Europe/Madrid')
Tagstagslist
(Optional) Brand tag ids; keeps only the content having any of them.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get calendar report

Get calendar report. Returns the full service response for the connected account.

Inputs

Startstartdate and time
The start date from you want to return the posts. ('2011-12-03T10:15:30')
Endenddate and time
The date until you want to return the posts. ('2011-12-04T10:15:30')
Timezonetimezonetext
The timezone in which you want to return the posts. ('Europe/Madrid')

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get calendar with it events in time period

Get calendar with it events in time period. Returns the full service response for the connected account.

Inputs

Init dateinit_datedate and timeRequired
init calendar period ('2025-02-01T00:00:00')
End dateend_datedate and timeRequired
end calendar period ('2025-03-01T00:00:00')
Time zonetime_zonetextRequired
time zone
Calendar IDcalendar_idnumberRequired
Calendar identification

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": {
      "calendar-id": 1,
      "calendar-name": "example",
      "end-date": {
        "dateTime": "example",
        "timezone": "example"
      },
      "events-all-day": [],
      "events-by-hour": [],
      "start-date": {
        "dateTime": "example",
        "timezone": "example"
      }
    },
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get campaign analytics

Get campaign analytics. Returns the full service response for the connected account.

Inputs

NetworknetworktextRequired
network.
MetricmetrictextRequired
metric.
Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
Campaign IDcampaign_idtextRequired
campaignId.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": 1,
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get campaign timeline

Get campaign timeline. Returns the full service response for the connected account.

Inputs

NetworknetworktextRequired
network.
MetricmetrictextRequired
metric.
Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
Campaign IDcampaign_idtextRequired
campaignId.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

List bluesky events

List bluesky events. Returns the full service response for the connected account.

Inputs

TypetypetextRequired
type.
Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
Pagepagenumber
page.
Pagesizepagesizenumber
pagesize.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List brand posts

List brand posts. Returns the full service response for the connected account.

Inputs

Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
Tagstagslist
(Optional) Brand tag ids; keeps only the content having any of them.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

List campaign dashboards

List campaign dashboards. Returns the full service response for the connected account.

Inputs

NetworknetworktextRequired
Ads network of the campaign (e.g. adwords, facebook_ads, tiktok_ads)
Campaign IDscampaign_idslistRequired
Provider campaign IDs

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

List google ads campaigns

List google ads campaigns. Returns the full service response for the connected account.

Inputs

Fromfrom_valuedate and timeRequired
From Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
Totodate and timeRequired
To Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
Timezonetimezonetext
(Optional) The timezone used for the date range to search. ('Europe/Madrid')
Tagstagslist
(Optional) Brand tag ids; keeps only the content having any of them.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

List tiktok ads campaigns

List tiktok ads campaigns. Returns the full service response for the connected account.

Inputs

Fromfrom_valuedate and timeRequired
from.
Totodate and timeRequired
to.
Timezonetimezonetext
timezone.
MetricsmetricslistRequired
metrics[].
Tagstagslist
(Optional) Brand tag ids; keeps only the content having any of them.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Post /v2/scheduler/posts/{postId}/notes

Post /v2/scheduler/posts/{postId}/notes.

Inputs

Post IDpost_idnumberRequired
postId.
Source post IDsource_post_idnumber
sourcePostId.
ContentcontenttextRequired
content.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Reschedule post

Reschedule post. Empty fields keep their current values.

Inputs

IdidnumberRequired
id of the post to update
FieldsfieldslistRequired
list of fields to updateOne or more of: publicationDate.
Publication timepublication_timedate and timeRequired
When to publish. Converted to UTC.
Publication timezonepublication_timezonetext
Use UTC with the publication time picker.One of: UTC.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": true,
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Returns best time values to publish

Get best time values to publish. Returns the full service response for the connected account.

Inputs

ProviderprovidertextRequired
supported values: facebook, instagram, tiktok, linkedin, youtube
Startstartdate and time
The start date from you want to return the besttimes. ('2011-12-03T10:15:30')
Endenddate and time
The date until you want to return the besttimes. ('2011-12-04T10:15:30')
Timezonetimezonetext
The timezone in which you want to return the besttimes. ('Europe/Madrid')

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Returns the list of brands of your account

Get the list of brands of your Metricool account. Returns the full service response for the connected account.

Inputs

None.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Returns the list of TikTok posts created during a period of time

Get the list of TikTok posts created during a period of time. Returns the full service response for the connected account.

Inputs

Fromfrom_valuedate and timeRequired
From Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
Totodate and timeRequired
To Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
Timezonetimezonetext
(Optional) The timezone used for the date range to search. ('Europe/Madrid')
Tagstagslist
(Optional) Brand tag ids; keeps only the content having any of them.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "data": [],
    "metadata": {},
    "page": {
      "next": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page