> ## Documentation Index
> Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.
Please review carefully for any potentially breaking changes.
See [What's New](https://www.ayrshare.com/docs/whatsnew/latest.md) for all new features.

**August 24, 2026**

<ul>
  <li>
    **YouTube: view counting changes for all video formats.** Starting August 24, 2026, YouTube counts a view from the moment a video starts to play, with no minimum watch time requirement — the methodology already used for Shorts. The YouTube `views` metric in [Post Analytics](https://www.ayrshare.com/docs/apis/analytics/post.md) and [Social Analytics](https://www.ayrshare.com/docs/apis/analytics/social.md) will reflect the new counting for long-form videos and live streams, so expect a one-time step up in YouTube view counts on that date. No integration changes are required. If you need views counted under the previous methodology, use the new `engagedViews` field returned by [Post Analytics](https://www.ayrshare.com/docs/apis/analytics/post.md) and [Social Analytics](https://www.ayrshare.com/docs/apis/analytics/social.md) for YouTube.
  </li>
</ul>

**June 15, 2026**

<ul>
  <li>
    **Facebook: Meta retired unique-impression (reach) and 3-second video-view Insights metrics.** Meta removed these metrics across all Graph API versions, so the affected fields are no longer returned. See the [Meta Graph API v25 changelog](https://developers.facebook.com/blog/post/2026/02/18/introducing-graph-api-v25-and-marketing-api-v25/) for details.

    <ul>
      <li>
        [GET analytics/post](https://www.ayrshare.com/docs/apis/analytics/post.md) no longer returns the following Facebook fields:

        <ul>
          <li>impressionsUnique → migrate to `totalMediaViewUnique` (unique reach)</li>
          <li>impressionsFanUnique, impressionsOrganicUnique, impressionsPaidUnique → no unique replacement for these splits. Use `totalMediaViewUnique` for overall unique reach, or the non-unique `mediaViewIsFromFollowers` / `mediaViewIsFromAds` for a follower or ads split.</li>
          <li>videoViewsUnique → use `videoViews` for non-unique 3-second views</li>
          <li>The `totalVideoViews*Unique` and `totalVideoImpressions*` families (e.g. `totalVideoViewsOrganicUnique`, `totalVideoViewsPaidUnique`, `totalVideoViewsUnique`)</li>
        </ul>
      </li>

      <li>
        [GET analytics/social](https://www.ayrshare.com/docs/apis/analytics/social.md) no longer returns the following Facebook fields:

        <ul>
          <li>`pagePostsImpressionsUnique` → migrate to `pageTotalMediaViewUnique` (unique reach)</li>
          <li>`pagePostsImpressionsPaid` → migrate to `pageMediaViewIsFromAds`</li>
          <li>The other non-unique `pagePostsImpressions*` fields (`pagePostsImpressions`, `pagePostsImpressionsViral`, `pagePostsImpressionsNonviral`) → migrate to `pageMediaView`</li>
          <li>The unique splits (`pagePostsImpressionsPaidUnique`, `pagePostsImpressionsOrganicUnique`, `pagePostsImpressionsViralUnique`, `pagePostsImpressionsNonviralUnique`, `pagePostsServedImpressionsOrganicUnique`) → no unique replacement for these splits. Use `pageTotalMediaViewUnique` for overall unique reach.</li>
          <li>pageVideoViewsUnique → use `pageVideoViews` for non-unique 3-second views</li>
        </ul>
      </li>

      <li>
        For reach, use the Total Unique Media Views successors: `totalMediaViewUnique` in post analytics and `pageTotalMediaViewUnique` in social analytics. `mediaView` / `pageMediaView` remain available for total, non-unique views. Still-supported fields such as `reactionsByType`, `videoViews`, `mediaView`, `pagePostEngagements`, `pageVideoViews`, and `pageVideoViewsPaid` are unaffected.
      </li>
    </ul>
  </li>
</ul>

**May 11, 2026**

<ul>
  <li>
    **YouTube transient failures now return HTTP 503/504 instead of 500:** Some YouTube upload failures previously surfacing as HTTP 500 (`code: 176`) now return HTTP 503 (`code: 454`) or HTTP 504 (`code: 453`). Both responses include `retryAvailable: true`. Customer integrations that filter on HTTP 500 to retry YouTube uploads should switch to filtering on the `retryAvailable` field on the response body. See [error codes](https://www.ayrshare.com/docs/errors/errors-ayrshare.md) for details.
  </li>
</ul>

**April 9, 2026**

<ul>
  <li>
    **Empty Analytics Returns Error 187:** Requesting [Social Analytics](https://www.ayrshare.com/docs/apis/analytics/social.md) or [Post Analytics](https://www.ayrshare.com/docs/apis/analytics/post.md) when no platforms return data now returns `{ "status": "error", "code": 187 }` instead of `{ "status": "success" }`. Update any client code that relies on the previous empty-success behavior.
  </li>
</ul>

**March 31, 2026**

<ul>
  <li>
    **X/Twitter BYO Key Requirement:** All X/Twitter operations through Ayrshare will require your own API credentials. After linking your X account via OAuth, include 2 headers in every X/Twitter request: `X-Twitter-OAuth1-Api-Key` and `X-Twitter-OAuth1-Api-Secret`. Requests without valid credentials will be rejected. See the [X BYO Key Setup Guide](https://www.ayrshare.com/docs/dashboard/connect-social-accounts/x-twitter-byo-keys.md) for instructions.
  </li>

  <li>
    **RSS-to-X Deprecated:** RSS auto-posting to X/Twitter will no longer be supported after March 31, 2026. RSS feeds run on a schedule without per-request credentials, which is incompatible with the BYO key model. RSS auto-posting to all other platforms is unaffected.
  </li>

  <li>
    **X Account Activity Webhook Deprecated:** The X Account Activity webhook action (`accountActivity`) will no longer be available after March 31, 2026. This includes all real-time event notifications for linked X accounts (posts, mentions, DMs, likes, follows, blocks, etc.).
  </li>
</ul>

**November 14, 2025**

<ul>
  <li>
    Starting November 14, 2025, Facebook will be deprecating the following fields for [GET analytics/social](https://www.ayrshare.com/docs/apis/analytics/social.md):

    <ul>
      <li>pageFans</li>
      <li>pageFansCity</li>
      <li>pageFansLocale</li>
      <li>pageFansCountry</li>
      <li>pageFansAdds</li>
      <li>pageFanAddsUnique</li>
      <li>pageFanRemoves</li>
      <li>pageFanRemovesUnique</li>
      <li>pageImpressions → migrate to `pageMediaView`</li>
      <li>pageImpressionsPaidUnique → migrate to `pageMediaViewIsFromAds`</li>
      <li>pageImpressionsUnique</li>
      <li>pageImpressionsViral</li>
      <li>pageImpressionsViralUnique</li>
      <li>pageImpressionsPaid → migrate to `pageMediaViewIsFromAds`</li>
    </ul>
  </li>

  <li>
    Starting November 14, 2025, Facebook will be deprecating the following fields for [GET analytics/post](https://www.ayrshare.com/docs/apis/analytics/post.md):

    <ul>
      <li>impressions and impressionsFanPaidUnique → migrate to `mediaView`. Granular breakdowns available via `mediaViewIsFromAds` (ad-attributed views) and `mediaViewIsFromFollowers` (follower-attributed views).</li>
      <li>postImpressionsUnique (Reels) → use `blueReelsPlayCount` for reel play count or `postVideoViewTime` for total watch time.</li>
    </ul>
  </li>
</ul>

**September 1, 2025**

<ul>
  <li>
    Starting September 1, 2025, the [get comments](https://www.ayrshare.com/docs/apis/comments/get-comments.md) endpoint for
    Instagram will no longer include the `text` field in reply objects. Use the `comment` field
    instead to access reply content.
  </li>
</ul>

**June 1, 2025**

<ul>
  <li>
    X (Twitter) [get comments](https://www.ayrshare.com/docs/apis/comments/get-comments.md) endpoint will move the user public
    metrics to the new `publicMetrics` object. The following fields will be moved from the top
    level to the `publicMetrics` object:

    <ul>
      <li>followersCount</li>
      <li>followingCount</li>
      <li>tweetCount</li>
      <li>listedCount</li>
      <li>mediaCount</li>
    </ul>
  </li>

  <li>
    Facebook will be deprecating the following fields for [GET
    analytics/social](https://www.ayrshare.com/docs/apis/analytics/social.md):

    <ul>
      <li>pageVideoViews10S</li>
      <li>pageVideoViews10SAutoplayed</li>
      <li>pageVideoViews10SClickToPlay</li>
      <li>pageVideoViews10SOrganic</li>
      <li>pageVideoViews10SPaid</li>
      <li>pageVideoViews10SRepeat</li>
      <li>pageVideoViews10SUnique</li>
    </ul>
  </li>
</ul>

**May 7, 2025**

<ul>
  <li>
    YouTube has deprecated the setting allowed and blocked regions. You can still add in the
    allowed and blocked regions to the post endpoint, but they will be ignored.
  </li>
</ul>

**April 20, 2025**

<ul>
  <li>
    The following metrics for [Instagram post analytics](https://www.ayrshare.com/docs/apis/analytics/post.md) will be deprecated:

    REELS:

    <ul>
      <li>
        playsCount
      </li>

      <li>
        clipsReplaysCount
      </li>

      <li>
        igReelsAggregatedAllPlaysCount
      </li>
    </ul>

    FEED/STORY:

    <ul>
      <li>
        impressionsCount
      </li>
    </ul>
  </li>

  <li>
    The [history endpoint](https://www.ayrshare.com/docs/apis/history/get-history.md) will enforce the cache for 1 minute if the `limit` is greater than the default value of 25.
  </li>
</ul>

**March 1, 2025**

The [get comments](https://www.ayrshare.com/docs/apis/comments/get-comments.md) endpoint for TikTok will standardize field names
to match other social networks.

<ul>
  <li>
    The field `replyList` will be renamed to `replies` and `profileImage` will be renamed to
    `profileImageUrl`.
  </li>

  <li>Both new field names are already available and can be used in your integration.</li>

  <li>
    TikTok as the following updates:

    <ul>
      <li>
        [social analytics](https://www.ayrshare.com/docs/apis/analytics/social.md) endpoint: The following changes are coming: •
        The `durationAverage` field will be deprecated and removed. • Due to TikTok API
        limitations, the fields `shareCountTotal`, `viewCountTotal` and `commentCountTotal` will
        now only return totals for the past 60 days instead of all-time totals. • To start using
        the 60-day totals now, add `period60Days: true` to your API request body Note: Using this
        parameter will significantly improve response times.
      </li>

      <li>
        [history platform](https://www.ayrshare.com/docs/apis/history/history-platform.md) and [post
        analytics](https://www.ayrshare.com/docs/apis/analytics/post.md) endpoints: The undocumented fields `caption`, `comments`,
        `shares`, `likes`, `shareUrl`, and `itemsId` will be removed - the fields `post`,
        `commentsCount`, `sharesCount`, `likesCount`, `postUrl`, and `id` should be used instead.
      </li>
    </ul>
  </li>
</ul>

**February 1, 2025**

The [/user](https://www.ayrshare.com/docs/apis/user/profile-details.md) endpoint is changing how it reports API usage:

<ul>
  <li>
    The `monthlyApiCalls` field will be expanded to count all API calls (posts, comments,
    analytics, etc.).
  </li>

  <li>For post-specific counts, use the new `monthlyPostCount` field.</li>

  <li>
    The `monthlyApiCallsQuota` field will be deprecated and replaced by the new `monthlyPostQuota`
    field.
  </li>
</ul>

**January 5, 2025**

<ul>
  <li>
    Meta is deprecating the `videoViews` field on the Instagram [post analytics
    endpoint](https://www.ayrshare.com/docs/apis/analytics/post.md).
  </li>

  <li>
    Additionally, the `emailContactsCount`, `getDirectionClicks`, `profileViewsCount`,
    `textMessageClicks`, `websiteClicksCount`, and `phoneCallClicksCount` fields will be removed
    from the Instagram [social analytics](https://www.ayrshare.com/docs/apis/analytics/social.md) endpoint.
  </li>

  <li>These fields will be removed on January 5, 2025.</li>
</ul>

**December 15, 2024**

<ul>
  <li>
    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](https://www.ayrshare.com/docs/apis/overview.md#authorization) on how to properly use a Profile Key.
  </li>
</ul>

**November 15, 2024**

<ul>
  <li>
    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.
  </li>

  <li>
    The history endpoint will now return responses as objects by default. The objResponse
    parameter will be set to true automatically.
  </li>

  <li>
    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.
  </li>
</ul>

**October 7, 2024**

<ul>
  <li>
    The media endpoint will no longer return url\_1080. If you do need to resize an image, please
    see the [resize endpoint](https://www.ayrshare.com/docs/apis/media/resize.md).
  </li>
</ul>

**September 16, 2024**

<ul>
  <li>
    **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](https://www.ayrshare.com/docs/apis/analytics/social.md).
  </li>

  <li>
    Facebook will be [deprecating several
    fields](https://developers.facebook.com/docs/pages-api/changelog/). The [social analytics
    endpoint](https://www.ayrshare.com/docs/apis/analytics/social-by-id.md) will no longer return these fields after September 16,
    2024\.
  </li>
</ul>

**June 3, 2024**

<ul>
  <li>
    The [new linked shortener](https://www.ayrshare.com/docs/apis/links/overview.md) system will replace the shortener endpoint,
    which has been deprecated by Google. The new link shortener requires the add-on [Max
    Pack](https://www.ayrshare.com/docs/additional/maxpack.md).
  </li>

  <li>
    Link shortening will be off (`false`) by default. To automatically shorten links use
    `shortenLinks: true` in the post endpoint call, which uses the new[ link
    endpoint](https://www.ayrshare.com/docs/apis/links/overview.md).
  </li>
</ul>

**April 22, 2024**

<ul>
  <li>
    Meta will be deprecating their Facebook Groups API. Please see the
    [announcement](https://www.ayrshare.com/blog/facebook-removes-groups-api-access-impact-and-implications/).
  </li>
</ul>

**April 16, 2024**

<ul>
  <li>
    Instagram has clarified the time period of the online followers data set. Please see here for
    [details](https://www.ayrshare.com/docs/apis/analytics/instagram-follower-count.md).
  </li>
</ul>

**April 1, 2024**

<ul>
  <li>
    [Reply to comment with comment ID](https://www.ayrshare.com/docs/apis/comments/reply-to-comment.md) 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.
  </li>
</ul>

**January 25, 2024**

<ul>
  <li>
    The [retry post endpoint](https://www.ayrshare.com/docs/apis/post/retry-post.md) will return a status of "pending" instead of
    "success" to better reflect the status of the retry.
  </li>

  <li>
    The [API changes on scheduleDate and
    createDate](https://www.ayrshare.com/docs/whatsnew/upcoming-api-changes.md#june-17-2022) will be released.
  </li>
</ul>

**December 8, 2023**

<ul>
  <li>
    The `/history/instagram` endpoint fields `caption`, `message`, `createdTime` and `timestamp`
    fields were deprecated on April 1, 2023 and will be removed. Please use the `post` and
    `created` fields.
  </li>

  <li>
    The `/history/linkedin` endpoint field `mediaUrls` 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 the
    `multiMedia` query parameter must be used to return media with multiple images. After December
    1, 2023 multiple images will be returned by default.
  </li>

  <li>
    The Scheduled Action TikTok webhook will have the String `platform` deprecated. Please use the
    `platforms` array field as is done for other Scheduled Action webhooks.
  </li>

  <li>The delete comment docs have been corrected to align with the correct return.</li>

  <li>
    The TikTok commentId field will be replaced with the id field to align with the standard
    comment delete format.
  </li>

  <li>
    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:
  </li>
</ul>

**October 18, 2023**

<ul>
  <li>
    The following [social analytics endpoint](https://www.ayrshare.com/docs/apis/analytics/social.md) YouTube fields will be
    returned as numeric instead of String values.
  </li>
</ul>

**May 30, 2023**

<ul>
  <li>
    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.
  </li>
</ul>

**May 8, 2023**

<ul>
  <li>
    We're excited to launch [TikTok direct publishing](https://www.ayrshare.com/docs/apis/post/social-networks/tiktok.md), 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.
  </li>

  <li>
    We're also introducing adding, getting, and deleting TikTok comments + demographic analytics
    data.
  </li>

  <li>
    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.
  </li>
</ul>

**February 17, 2023**

<ul>
  <li>
    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, 2023.
  </li>
</ul>

**October 1, 2022**

<ul>
  <li>Get All Posts descriptions, text, message fields standardized to `post` field.</li>
</ul>

**September 12, 2022**

<ul>
  <li>TikTok fields deprecated: `shareUrl`. Use `postUrl` instead.</li>
</ul>

**June 17, 2022**

<ul>
  <li>
    For all history endpoints the fields `createdAt`, `createdTime`, and `timestamp` will be
    replaced by the `created` field which returns the creation time in UTC format.
  </li>

  <li>
    The `scheduleDate` field will no longer return an Object by a String containing the schedule
    time in UTC format.
  </li>

  <li>
    The undocumented `created_date` field on /history will be removed. Use `created` instead.
  </li>
</ul>

**April 22, 2022**

<ul>
  <li>
    Analytics on a [Facebook post](https://www.ayrshare.com/docs/apis/analytics/post.md) returns `reactions` as an object in the
    following format.
  </li>
</ul>

**April 1, 2022**

<ul>
  <li>
    History by default will return the last 20 posts. Up to 500 can be returned with the
    `lastRecords` parameter.
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.