Mentioned Media

Returns data on an IG Media object in which an IG User has been @mentioned in a caption by another Instagram user.

Creating

This operation is not supported.

Reading

GET {/ig-user-id}?fields=mentioned_media.media_id({media_id}){fields}

Returns data on an IG Media object in which an IG User has been @mentioned in a caption by another Instagram user.

Query String Parameters

Query string parameters are optional unless indicated as required.

  • {media_id} (required) — The ID of the IG Media object in which the IG User has been @mentioned. Included in the Webhook notification payload.
  • {fields} — A list of IG Media object fields you want returned. See Returnable Fields.

Permissions

A Facebook User access token with the following permissions:

  • instagram_basic
  • instagram_manage_comments
  • manage_pages or pages_show_list

If the token is from a User whose Page role was granted via the Business Manager, one of the following permissions is also required:

  • ads_management
  • manage_pages
  • business_management

Returnable Fields

  • caption
  • comments
  • comments_count
  • like_count
  • media_type
  • media_url
  • owner — The ID of the user who owns the object.
  • timestamp
  • username

Pagination

If you are using field expansion to access an edge that supports cursor-based pagination, the response will include before and after cursors if the response contains multiple pages of data. Unlike standard cursor-based pagination, however, the response will not include previous or next fields, so you will have to use the before and after cursors to construct previous and next query strings manually in order to page through the returned data set.

Sample Request

GET graph.facebook.com
  /17841405309211844
    ?fields=mentioned_media.media_id(17873440459141021){caption,media_type}

Sample Response

{
  "mentioned_media": {
    "caption": "At @metricsaurus headquarters!",
    "media_type": "IMAGE",
    "id": "17873440459141021"
  },
  "id": "17841405309211844"
}

Updating

This operation is not supported.

Deleting

This operation is not supported.