Inbox · Instagram

Get Instagram story insights

Fetches Instagram story insights.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/instagram/stories/{storyId}/insights

getInstagramStoryInsights

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`accountId`required	string
`storyId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/instagram/stories/62c55df6d7c6e25c9304798b/insights" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/instagram/stories/62c55df6d7c6e25c9304798b/insights", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/instagram/stories/62c55df6d7c6e25c9304798b/insights",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

dataobjectrequired
- sourcestringrequired
  One of live, cached, unavailable.
- metricsobjectrequired
  13 child fields
  - viewsintegerrequired
  - reachintegerrequired
  - repliesintegerrequired
  - sharesintegerrequired
  - navigationintegerrequired
  - tapsForwardintegerrequired
  - tapsBackintegerrequired
  - exitsintegerrequired
  - swipesForwardintegerrequired
  - profileVisitsintegerrequired
  - followsintegerrequired
  - repostsintegerrequired
  - totalInteractionsintegerrequired

200 response

{
  "data": {
    "source": "live",
    "metrics": {
      "views": 1,
      "reach": 1,
      "replies": 1,
      "shares": 1,
      "navigation": 1,
      "tapsForward": 1,
      "tapsBack": 1,
      "exits": 1,
      "swipesForward": 1,
      "profileVisits": 1,
      "follows": 1,
      "reposts": 1,
      "totalInteractions": 42
    }
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Instagram

GETList active Instagram stories GETGet Instagram publishing limit GETSearch Instagram audio GETGet Instagram audio metadata GETLook up a public Instagram Business account GETList the collaborators of an Instagram post GETList the live broadcasts of an Instagram account GETList the posts an Instagram account is tagged in GETGet a post that mentions an Instagram account in its caption GETGet a comment that mentions an Instagram account