Skip to main content

​
What it does

Returns all story items within a highlight reel, including images and videos. The highlight ID comes from the highlights list endpoint.

​
Tool details

FieldValue
Tool nameinstagram.get_highlight_stories
PlatformInstagram
REST endpointGET /v1/instagram/highlights/{highlightId}
Result typeCollection tool

​
Parameters

ParameterSourceTypeRequiredDescription
highlightIdpathstringYesInstagram highlight ID
projection_presetsharedstringNoOptional. Defaults to minimal. Allowed values: full, minimal, identity, engagement, content.
data_fieldssharedstring[]NoOptional. Adds top-level keys from data on top of the selected projection_preset.
item_fieldssharedstring[]NoOptional. Adds keys from data.orderedItems[] on top of the selected projection_preset.

​
Example

{
  "name": "instagram.get_highlight_stories",
  "arguments": {
    "highlightId": "18067016518767507",
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "totalItems",
      "entityId",
      "name"
    ],
    "item_fields": [
      "entityId",
      "published",
      "summary",
      "url",
      "attachment"
    ]
  }
}

​
Available data fields

[
  "@context",
  "type",
  "id",
  "entityId",
  "name",
  "image",
  "totalItems",
  "orderedItems"
]

​
Available item fields

[
  "type",
  "url",
  "entityId",
  "published",
  "summary",
  "isSponsored",
  "image",
  "attachment",
  "duration",
  "attributedTo"
]

​
Response notes

Successful calls return a JSON object with a top-level data field and, when available, metadata.creditsUsed and metadata.creditsRemaining. See response format, pagination, and credits.