IG Media

Represents an Instagram album, photo, or video (uploaded video, live video, reel, or story).

If you are migrating from Marketing API Instagram Ads endpoints to Instagram Platform endpoints, be aware that some field names are different.

Introducing the following field:

legacy_instagram_media_id

The following Marketing API Instagram Ads endpoint fields are not supported:

filter_name
location
location_name
latitude
longitude

Creating

This operation is not supported.

Reading

GET /<IG_MEDIA_ID>

Gets fields and edges on Instagram media.

Requirements

	Instagram API with Instagram Login	Instagram API with Facebook Login
Access Tokens	Instagram User access token	Facebook User access token
Host URL	`graph.instagram.com`	`graph.facebook.com`
Login Type	Business Login for Instagram	Facebook Login for Business
Permissions	`instagram_business_basic`	`instagram_basic` `pages_read_engagement` If the app user was granted a role via the Business Manager on the Page connected to your app user's Instagram professional account, your app will also need one of: `ads_management` `ads_read`

Limitations

Fields that return aggregated values don't include ads-driven data. For example, comments_count returns the number of comments on a photo, but not comments on ads that contain that photo.
Captions don't include the @ symbol unless the app user is also able to perform admin-equivalent tasks on the app.
Some fields, such as permalink, cannot be used on photos within albums (children).
Live video Instagram Media can only be read while they are being broadcast.
This API returns only data for media owned by Instagram professional accounts. It can not be used to get data for media owned by personal Instagram accounts.

Request Syntax

GET https://<HOST_URL>/<API_VERSION>/<IG_MEDIA_ID> \
  ?fields=<LIST_OF_FIELDS> \
  &access_token=<ACCESS_TOKEN>

Path Parameters

Placeholder	Value
`<API_VERSION>` The latest version is: `v22.0`	The API version your app is using. If not specified in your API calls this will be the latest version at the time you created your Meta app or, if that version is no longer available, the oldest version available.Learn more about versioning.
`<HOST_URL>`	The host URL your app is using to query the endpoint.
`<IG_MEDIA_ID>`	Required. ID for the media to be published.

Query String Parameters

Key	Placeholder	Value
`access_token`	`<ACCESS_TOKEN>`	Required. The app user's Facebook or Instagram User access token.
`fields`	`<LIST_OF_FIELDS>`	Comma-separated list of fields you want returned.

Fields

Public fields can be read via field expansion.

Field Description

boost_ads_list

Offers an overview of all Instagram ad information associated with the organic media. It includes relative ad ID and ad delivery status. Available for Instagram API with Facebook Login only.

boost_eligibility_info

The field provides information about boosting eligibility of a Instagram instagram media as an ad and additional details if not eligible. Available for Instagram API with Facebook Login only.

caption
Public

Caption. Excludes album children. The @ symbol is excluded, unless the app user can perform admin-equivalent tasks on the Facebook Page connected to the Instagram account used to create the caption. Available for Instagram API with Facebook Login only.

comments_count
Public

Count of comments on the media. Excludes comments on album child media and the media's caption. Includes replies on comments.

copyright_check_information.status

Returns status and matches_found objects

status objects Description

status

completed – the detection process has finished
error – an error occurred during the detection process
in_progress – the detection process is ongoing
not_started – the detection process has not started

matches_found

Set to one of the following:

false if the video does not violate copyright,
true if the video does violate copyright

If a video is violating copyright, the copyright_matches is returned with an array of objects about the copyrighted material, when the violation is occurring in the video, and the actions take to mitigate the violation.

copyright_matches objects	Description
`author`	the author of the copyrighted video
`content_title`	the name of the copyrighted video
`matched_segments`	An array of objects with the following key-value pairs: `duration_in_seconds` – the number of seconds the content violates copyright `segment_type` – either `AUDIO` or `VIDEO` `start_time_in_seconds` – set to the start time of the video
`owner_copyright_policy`	Objects returned include: `name` – The name for the copyright owners' policy `actions` – An array of `action` objects with the mitigations steps taken defined by the copyright owner's policy. May include different mitigations steps for different locations. `action` – The mitigation action taken against the video violating copyright. Different mitigation steps can be taken for different countries. Can be one of the following values: `BLOCK` – The video is blocked from the audiences listed in the `geos` array `MUTE` - The video is muted for audiences listed in the `geos` array

id
Public

Media ID.

is_comment_enabled

Indicates if comments are enabled or disabled. Excludes album children.

is_shared_to_feed
Public

For Reels only. When true, indicates that the reel can appear in both the Feed and Reels tabs. When false, indicates that the reel can only appear in the Reels tab.

Neither value determines whether the reel actually appears in the Reels tab because the reel may not meet eligibilty requirements or may not be selected by our algorithm. See reel specifications for eligibility critera.

legacy_instagram_media_id

The ID for Instagram media that was created for Marketing API endpoints for v21.0 and older.

like_count

Count of likes on the media, including replies on comments. Excludes likes on album child media and likes on promoted posts created from the media.

If queried indirectly through another endpoint or field expansion the like_count field is omitted if the media owner has hidden like counts.

media_product_type
Public

Surface where the media is published. Can be AD, FEED, STORY or REELS. Available for Instagram API with Facebook Login only.

media_type
Public

Media type. Can be CAROUSEL_ALBUM, IMAGE, or VIDEO.

media_url
Public

The URL for the media.

The media_url field is omitted from responses if the media contains copyrighted material or has been flagged for a copyright violation. Examples of copyrighted material can include audio on reels.

owner
Public

Instagram user ID who created the media. Only returned if the app user making the query also created the media; otherwise, username field is returned instead.

permalink
Public

Permanent URL to the media.

shortcode
Public

Shortcode to the media.

thumbnail_url
Public

Media thumbnail URL. Only available on VIDEO media.

timestamp
Public

ISO 8601-formatted creation date in UTC (default is UTC ±00:00).

username
Public

Username of user who created the media.

Edges

Public edges can be returned through field expansion.

Edge	Description
`children` Public.	Represents a collection of Instagram Media objects on an album Instagram Media.
`collaborators`	Represents a list of users who are added as collaborators on an Instagram Media object. Available for Instagram API with Facebook Login only.
`comments`	Represents a collection of Instagram Comments on an Instagram Media object.
`insights`	Represents social interaction metrics on an Instagram Media object.

cURL Example

Example request

curl -X GET \
  'https://graph.instagram.com/v22.0/17895695668004550?fields=id,media_type,media_url,owner,timestamp&access_token=IGQVJ...'

Example response

{
  "id": "17918920912340654",
  "media_type": "IMAGE",
  "media_url": "https://sconten...",
  "owner": {
    "id": "17841405309211844"
  },
  "timestamp": "2019-09-26T22:36:43+0000"
}

Updating

POST /<IG_MEDIA_ID>

Enable or disable comments on an Instagram Media.