instagram

Highlights

Returns a user's saved story highlight collections, each with its title, cover image, and the number of items inside.

Use it to list the highlight collections on a profile, then pass one of the ids to highlight/detail to open it.

10 credits per call.

get/v1/instagram/highlights

Request

  • Base URL: https://api.insightsocial.app
  • URL: https://api.insightsocial.app/v1/instagram/highlights
  • Auth: API key in header x-api-key

Query parameters

user_idstring

Instagram user id. Use for faster response times. Provide at least one of: user_id, handle.

handlestring
Example:instagram

Instagram username without the @ symbol. Provide at least one of: user_id, handle.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept.

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Response

Success.

successtrue required
platformstring required
endpointstring required
schema_version'2' required
unavailablestring[] required
credits_usedinteger required
credits_remaininginteger required
request_idstring required
cachedboolean required
idempotent_replayboolean required
charge_reasonstring required
free_callboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.