Skip to content
Dashboard

Instagram posts with their numbers and their funnel

GET
/instagram/insights/posts
curl --request GET \
--url 'https://app.whatsetter.com/api/v1/instagram/insights/posts?days=7&tz=Europe%2FParis' \
--header 'Authorization: Bearer <token>'

The posts published in the period (7, 30 or 90 days) with Instagram’s numbers (views, reach, likes, comments, saves, shares, interactions, engagement = interactions / reach), each post’s views against the average of its kind (views_vs_average: reels against reels, photos and carousels together; the average is the last 20 posts of the kind older than 48 h, so a post younger than that is still_growing and has none), its rank by views, and what the workspace’s automations made of it: comments seen, private messages sent, links sent and opened, people who replied, qualified leads and meetings booked by the agent. Instagram’s numbers arrive up to 48 h late and are cached an hour. Without the insights permission (access.reconnect_required), likes and comments only. Requires scope instagram:read.

account_id
string

Required when the workspace has several Instagram accounts.

days
integer
default: 30
Allowed values: 7 30 90
tz
string
Example
Europe/Paris

IANA time zone of the period (default the account’s agent’s).

The period’s posts

Media typeapplication/json
object
data
object
account
object
id
string
username
string
nullable
period
object
days
integer
from
string format: date-time
to
string format: date-time
tz
string
access
object
insights
boolean
reconnect_required
boolean
reason
string
nullable
Allowed values: scope expired
averages
object
reels
object
posts

Posts the average is made of (3 at least to compare).

integer
views
integer
nullable
reach
integer
nullable
engagement
number
nullable
photos_and_carousels
object
posts

Posts the average is made of (3 at least to compare).

integer
views
integer
nullable
reach
integer
nullable
engagement
number
nullable
posts
Array<object>
object
id
string
kind
string
Allowed values: reel post carousel
caption

The first 600 characters.

string
permalink
string
nullable
published_at
string format: date-time
views
integer
nullable
reach
integer
nullable
likes
integer
nullable
comments
integer
nullable
saves
integer
nullable
shares
integer
nullable
interactions
integer
nullable
engagement

Interactions over accounts reached.

number
nullable
views_vs_average

2.3 = 2.3× the average of its kind.

number
nullable
rank_by_views
integer
nullable
still_growing

Published less than 48 h ago.

boolean
funnel
object
comments
integer
messages_sent
integer
links_sent
integer
link_clicks
integer
replied
integer
qualified
integer
meetings_booked
integer
fetched_at
string format: date-time
nullable
stale

Instagram did not answer; these are the last numbers received.

boolean
Example
{
"data": {
"access": {
"reason": "scope"
},
"posts": [
{
"kind": "reel"
}
]
}
}

Missing, unknown or revoked API key

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

The key lacks the required scope (insufficient_scope), the plan does not have this part of the API (not_in_plan), or Instagram is not enabled on the workspace (instagram_not_enabled, Instagram routes)

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Resource not found in this workspace

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Invalid parameter or body (also an invalid or expired cursor)

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Instagram limits the reads for this account right now (instagram_rate_limited).

Instagram does not answer right now (instagram_unavailable).