Upcoming API Changes
Changes to the API that may impact your integration
The following changes to the API will be effective on the date specified. Then review carefully for any potentially breaking changes. Please see What’s New for new features.
Meta is deprecating the
videoViews
field on the Instagram post analytics endpoint.Additionally, the
emailContactsCount
,getDirectionClicks
,profileViewsCount
,textMessageClicks
,websiteClicksCount
, andphoneCallClicksCount
fields will be removed from the Instagram social analytics endpoint.- These fields will be removed on January 5, 2025.
For enhanced security, we will prevent Profile Keys from being used as API Keys. If you attempt to use a Profile Key in place of the API Key, the system will return an error. See here on how to properly use a Profile Key.
We’ve updated how errors for TikTok scheduled webhooks are reported. These errors will now appear in the errors array, consistent with our error handling for other scheduled webhook types. Note, the current top-level errors will still be returned, but we encourage use of the errors array.
The history endpoint will now return responses as objects by default. The objResponse parameter will be set to true automatically.
Get All History LinkedIn will return an array for the mediaUrls object. Previously an object was returned if only one media item and an array if multiple media items. Now an array will always be returned even if only a single media item. If you need the previous behavior, you can use the
objResponse: false
query parameter.
The media endpoint will no longer return url_1080. If you do need to resize an image, please see the resize endpoint.
Update September 25, 2024: Meta (Facebook) has released the fields deprecation, so the removal of the fields are in effect. Please see the updated returned in social analytics.
Facebook will be deprecating several fields. The social analytics endpoint will no longer return these fields after September 16, 2024.
The new linked shortener system will replace the shortener endpoint, which has been deprecated by Google. The new link shortener requires the add-on Max Pack.
Link shortening will be off (
false
) by default. To automatically shorten links useshortenLinks: true
in the post endpoint call, which uses the new link endpoint.
Meta will be deprecating their Facebook Groups API. Please see the announcement.
Instagram has clarified the time period of the online followers data set. Please see here for details.
Reply to comment with comment ID default response will be an object as listed in the docs instead of an Array. You may use the objResponse parameter set to boolean
false
if wish to keep an Array response.
The retry post endpoint will return a status of “pending” instead of “success” to better reflect the status of the retry.
The API changes on scheduleDate and createDate will be released.
The
/history/instagram
endpoint fieldscaption
,message
,createdTime
andtimestamp
fields were deprecated on April 1, 2023 and will be removed. Please use thepost
andcreated
fields.The
/history/linkedin
endpoint fieldmediaUrls
will be returned as an array instead of an object to support multiple images. You can force the array being returned now by including the LinkedIn query parameter?multiMedia=true
. Please note, before December 1, 2023 themultiMedia
query parameter must be used to return media with multiple images. After December 1, 2023 multiple images will be returned by default.The Scheduled Action TikTok webhook will have the String
platform
deprecated. Please use theplatforms
array field as is done for other Scheduled Action webhooks.- The delete comment docs have been corrected to align with the correct return.
The TikTok commentId field will be replaced with the id field to align with the standard comment delete format.
The Twitter delete comment return will no longer contain a
posts
array so the return aligns with the standard comment delete format. The new return will be as follows:
The following social analytics endpoint YouTube fields will be returned as numeric instead of String values.
We have upgrade to Twitter’s new API version 2. Twitter has deprecated a few fields in Version 2, which affects the /analytics/social and getAllHistory endpoints. These following fields will still be returned until September 1, 2023, but will have a zero or empty string value.
We’re excited to launch TikTok direct publishing, comment management, and advanced analytics. Your users will no longer need to open their TikTok mobile app to post and enter caption text. Now after sending via Ayrshare, the TikTok video and caption is directly published.
We’re also introducing adding, getting, and deleting TikTok comments + demographic analytics data.
Your user will need to unlink and relink their TikTok account to enable direct publishing. Existing connections will continue with the indirect method and require the TikTok mobile app to publish.
Google Business Profile has changed the available social analytics data available. The new fields available are the following. Previous fields will still be present, but with a zero value and fully removed on March 17, 2003.
- Get All Posts descriptions, text, message fields standardized to
post
field.
- TikTok fields deprecated:
shareUrl
. UsepostUrl
instead.
For all history endpoints the fields
createdAt
,createdTime
, andtimestamp
will be replaced with thecreated
field which returns the creation time in UTC format.The
scheduleDate
field will no longer return an Object by a String containing the schedule time in UTC format.The undocumented
created_date
field on /history will be removed. Usecreated
instead.
Analytics on a Facebook post returns
reactions
as an object in the following format.
History by default will return the last 20 posts. Up to 500 can be returned with the
lastRecords
parameter.