> ## 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](/whatsnew/latest) for all new features.

<Update label="April 9, 2026">
  <ul class="custom-bullets">
    <li>
      **Empty Analytics Returns Error 187:** Requesting [Social Analytics](/apis/analytics/social) or [Post Analytics](/apis/analytics/post) 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>
</Update>

<Update label="March 31, 2026">
  <ul class="custom-bullets">
    <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](/dashboard/connect-social-accounts/x-twitter-byo-keys) 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>
</Update>

<Update label="November 14, 2025">
  <ul class="custom-bullets">
    <li>
      Starting November 14, 2025, Facebook will be deprecating the following fields for [GET analytics/social](/apis/analytics/social):

      <ul class="custom-bullets">
        <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](/apis/analytics/post):

      <ul class="custom-bullets">
        <li>impressions → migrate to `mediaView`. Granular breakdowns available via `mediaViewIsFromAds` (ad-attributed views) and `mediaViewIsFromFollowers` (follower-attributed views).</li>
      </ul>
    </li>
  </ul>
</Update>

<Update label="September 1, 2025">
  <ul class="custom-bullets">
    <li>
      Starting September 1, 2025, the [get comments](/apis/comments/get-comments) endpoint for
      Instagram will no longer include the `text` field in reply objects. Use the `comment` field
      instead to access reply content.
    </li>
  </ul>
</Update>

<Update label="June 1, 2025">
  <ul class="custom-bullets">
    <li>
      X (Twitter) [get comments](/apis/comments/get-comments) 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 class="custom-bullets">
        <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](/apis/analytics/social):

      <ul class="custom-bullets">
        <li>pageVideoViews10S</li>
        <li>pageVideoViews10SAutoplayed</li>
        <li>pageVideoViews10SClickToPlay</li>
        <li>pageVideoViews10SOrganic</li>
        <li>pageVideoViews10SPaid</li>
        <li>pageVideoViews10SRepeat</li>
        <li>pageVideoViews10SUnique</li>
      </ul>
    </li>
  </ul>
</Update>

<Update label="May 7, 2025">
  <ul class="custom-bullets">
    <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>
</Update>

<Update label="April 20, 2025">
  <ul class="custom-bullets">
    <li>
      The following metrics for [Instagram post analytics](/apis/analytics/post) will be deprecated:

      REELS:

      <ul class="custom-bullets">
        <li>
          playsCount
        </li>

        <li>
          clipsReplaysCount
        </li>

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

      FEED/STORY:

      <ul class="custom-bullets">
        <li>
          impressionsCount
        </li>
      </ul>
    </li>

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

<Update label="March 1, 2025">
  The [get comments](/apis/comments/get-comments) endpoint for TikTok will standardize field names
  to match other social networks.

  <ul class="custom-bullets">
    <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 class="custom-bullets">
        <li>
          [social analytics](/apis/analytics/social) 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](/apis/history/history-platform) and [post
          analytics](/apis/analytics/post) 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>
</Update>

<Update label="February 1, 2025">
  The [/user](/apis/user/profile-details) endpoint is changing how it reports API usage:

  <ul class="custom-bullets">
    <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>
</Update>

<Update label="January 5, 2025">
  <ul class="custom-bullets">
    <li>
      Meta is deprecating the `videoViews` field on the Instagram [post analytics
      endpoint](/apis/analytics/post).
    </li>

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

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

<Update label="December 15, 2024">
  <ul class="custom-bullets">
    <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](/apis/overview#authorization) on how to properly use a Profile Key.
    </li>
  </ul>
</Update>

<Update label="November 15, 2024">
  <ul class="custom-bullets">
    <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>
</Update>

<Update label="October 7, 2024">
  <ul class="custom-bullets">
    <li>
      The media endpoint will no longer return url\_1080. If you do need to resize an image, please
      see the [resize endpoint](/apis/media/resize).
    </li>
  </ul>
</Update>

<Update label="September 16, 2024">
  <ul class="custom-bullets">
    <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](/apis/analytics/social).
    </li>

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

<Update label="June 3, 2024">
  <ul class="custom-bullets">
    <li>
      The [new linked shortener](/apis/links/overview) system will replace the shortener endpoint,
      which has been deprecated by Google. The new link shortener requires the add-on [Max
      Pack](/additional/maxpack).
    </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](/apis/links/overview).
    </li>
  </ul>
</Update>

<Update label="April 22, 2024">
  <ul class="custom-bullets">
    <li>
      Meta will be deprecating their Facebook Groups API. Please see the
      [announcement](https://www.ayrshare.com/facebook-removes-groups-api-access-impact-and-implications/).
    </li>
  </ul>
</Update>

<Update label="April 16, 2024">
  <ul class="custom-bullets">
    <li>
      Instagram has clarified the time period of the online followers data set. Please see here for
      [details](/apis/analytics/instagram-follower-count).
    </li>
  </ul>
</Update>

<Update label="April 1, 2024">
  <ul class="custom-bullets">
    <li>
      [Reply to comment with comment ID](/apis/comments/reply-to-comment) 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>
</Update>

<Update label="January 25, 2024">
  <ul class="custom-bullets">
    <li>
      The [retry post endpoint](/apis/post/retry-post) 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](/whatsnew/upcoming-api-changes#changes-in-effect-june-17-2022) will be released.
    </li>
  </ul>
</Update>

<Update label="December 8, 2023">
  <ul class="custom-bullets">
    <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>
</Update>

<Update label="October 18, 2023">
  <ul class="custom-bullets">
    <li>
      The following [social analytics endpoint](/apis/analytics/social) YouTube fields will be
      returned as numeric instead of String values.
    </li>
  </ul>
</Update>

<Update label="May 30, 2023">
  <ul class="custom-bullets">
    <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>
</Update>

<Update label="May 8, 2023">
  <ul class="custom-bullets">
    <li>
      We're excited to launch [TikTok direct publishing](/apis/post/social-networks/tiktok), 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>
</Update>

<Update label="February 17, 2023">
  <ul class="custom-bullets">
    <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>
</Update>

<Update label="October 1, 2022">
  <ul class="custom-bullets">
    <li>Get All Posts descriptions, text, message fields standardized to `post` field.</li>
  </ul>
</Update>

<Update label="September 12, 2022">
  <ul class="custom-bullets">
    <li>TikTok fields deprecated: `shareUrl`. Use `postUrl` instead.</li>
  </ul>
</Update>

<Update label="June 17, 2022">
  <ul class="custom-bullets">
    <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>
</Update>

<Update label="April 22, 2022">
  <ul class="custom-bullets">
    <li>
      Analytics on a [Facebook post](/apis/analytics/post) returns `reactions` as an object in the
      following format.
    </li>
  </ul>
</Update>

<Update label="April 1, 2022">
  <ul class="custom-bullets">
    <li>
      History by default will return the last 20 posts. Up to 500 can be returned with the
      `lastRecords` parameter.
    </li>
  </ul>
</Update>