Create Report

Create the report of an Instagram account

POST https://hypeauditor.com/api/marketanalysis/instagramCompetitorAnalysis

Request Format

Request type supported:

Content-Type: application/json with json body request:

{
	"date_from":"2022-08-14",
	"date_to":"2022-09-13",
	"audience_geo":[],
	"username":"gucci",
	"hashtags":[]
}

Attributes	Type
date_from	str	Start Date
date_to	str	End Date
audience_geo	array of str	Country Code in ISO 3166 two letters
username	str	Instagram account
hashtags	array of str	Instagram hashtags

Images (posts and avatars)

Pictures stored on our CDN side (cdn.hypeauditor.com/*) have a lifespan of 28 days. You should re-request them if you cache their URIs on your side.

Response Object

Attributes	Type
config	object	Report Configuration Parameters
basic	object	Report Data
time_updated	str	Time report updated in `yyyy/mm/dd`

Config Object

Attributes	Type
username	str	Instagram username
date_from	str	Start Date in `yyyy/mm/dd`
date_to	str	End Date in `yyyy/mm/dd`
audience_geo	array of str	Country Code in ISO 3166 two letters
mode	str	FULL
type	str	Type of Report: `ig_mentions`

Basic Object

Attributes	Type
type	str	Type of Report: `ig_mentions`
username	str	Instagram account username
date_from	str	Start Date in `yyyy/mm/dd`
date_to	str	End Date in `yyyy/mm/dd`
audience_geo	array of str	Country Code in ISO 3166 two letters
report_id	str	Report unique ID
state	int	State of Report: `0: calculating` or `10: ready`
avatar_url	str	Avatar URL
social_id	str	Instagram account ID

Response

{
    "report": {
        "config": {
            "username": "gucci",
            "date_from": "2022-08-14T00:00:00",
            "date_to": "2022-09-13T00:00:00",
            "audience_geo": [],
            "settings": null,
            "mode": "FULL",
            "type": "ig_mentions"
        },
        "basic": {
            "type": "ig_mentions",
            "username": "gucci",
            "date_from": "2022-08-14T00:00:00",
            "date_to": "2022-09-13T00:00:00",
            "audience_geo": [],
            "report_id": "16fc27a0ead745eb730639f773b7093d",
            "state": 10,
            "avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/2421050.jpg?w=150&till=1675083600&sign=39d0ce00251532b917e669144c0c5932",
            "social_id": "2421050"
        }
    }
}

Get Report

Get the report of an Instagram account by report_id

GET https://hypeauditor.com/api/marketanalysis/instagramCompetitorAnalysis/<report_id>

Response Object

Attributes	Type
emv_value	int	Earned Media Value (EMV)
reach_value	int	Reach value
contributors_value	int	Contributors Value
mentions_value	int	Mentions Value
sponsored_ratio_prc	float	Ratio Percentage of Sponsored Content
cpe_value	float	Cost Per Engagement
sponsored	array	array of `{emv:int, reach: int, contributors: int, mentions: int, price_sum: int}` object. `emv` is Earned Media Value, `reach` is reach estimated, `contributors` is quantity of contributors, `mentions` is number of times influencer was mentioned, `prices_sum` is sum of prices
likely_sponsored	array	array of `{emv:int, reach: int, contributors: int, mentions: int, price_sum: int}` object. `emv` is Earned Media Value, `reach` is reach estimated, `contributors` is quantity of contributors, `mentions` is number of times influencer was mentioned, `prices_sum` is sum of prices
price	array of objects	array of `{sum_from: int, sum_to: int}` object. `sum_from` is sum starting interval, `sum_to` is sum final interval
content_top_hashtags	array of objects	array of `{title: str, value: int}` objects. `title` is Instagram account name, `value` is number of content hashtags

Response

{
    "emv_value": 6956273.040000001,
    "reach_value": 40509851,
    "contributors_value": 3819,
    "mentions_value": 4987,
    "sponsored_ratio_prc": 6.48,
    "cpe_value": 1.425098,
    "sponsored": {
        "emv": 4284329,
        "reach": 11634334,
        "contributors": 223,
        "mentions": 323,
        "price_sum": 559816
    },
    "likely_sponsored": {
        "emv": 5329684,
        "reach": 11969270,
        "contributors": 520,
        "mentions": 716,
        "price_sum": 1004039
    },
    "price": {
        "sum_from": 419590,
        "sum_to": 1259310
    },
    "content_top_hashtags": [
        {
            "title": "gucci",
            "value": 156
        },
        {
            "title": "alessandromichele",
            "value": 26
        },
        {
            "title": "fashion",
            "value": 22
        },
        {
            "title": "stanleykubrick",
            "value": 18
        },
        {
            "title": "ootd",
            "value": 16
        },
        {
            "title": "guccieyewear",
            "value": 15
        },
        {
            "title": "exquisitegucci",
            "value": 13
        },
        {
            "title": "gucciattache",
            "value": 12
        },
        {
            "title": "guccishoes",
            "value": 10
        },
        {
            "title": "theshining",
            "value": 10
        }
    ]
}

Get Posts

Get the posts from the report of an Instagram account:

POST https://hypeauditor.com/api/marketanalysis/instagramCompetitorAnalysis/posts

Request Format

Request type supported:

Content-Type: application/json with json body request:

{
	"report_id":"16fc27a0ead745eb730639f773b7093d",
	"from":0,
	"size":10
}

Attributes	Type
report_id	str	Report unique ID
from	int	Number of page
size	int	Number of posts per page

Response Object

The Response Object contains an array of posts objects:

Attributes	Type
post_date	str	Post Date in `yyyy/mm/dd`
account	str	Instagram account username
account_url	str	Instagram account URL
post	str	Post caption
post_url	str	Post URL code
type_of_payed	str	Type of post, ex. `organic`
post_er	float	Post Engagement Rate
post_reach	int	Post Reach
post_performance	float	Post Performance
post_likes	int	Number of likes
post_comments	int	Number of comments
post_video_views	int	Number of post views
account_type	str	Type of account, ex. `Human`
account_category	str	Type of category
account_is_verified	boolean	Account is verified
account_followers	int	Number of account followers
account_audience_country	str	Country Code in ISO 3166 two letters
account_audience_region	str	Audience region
account_audience_age	str	Audience age
account_audience_gender	str	Account audience gender, ex. `Female`
account_aqs	int	Blogger AQS
account_er	float	Blogger Engagement Rate
account_quality_audience	int	Blogger quality audience
account_quality_audience_prc	float	Blogger quality audience percentage
account_reach	int	Blogger reach
total_accounts_posts	int	Number of account posts
account_posts_performance	float	Performance of account posts
account_avg_likes_per_posts	int	Average of account likes per post
account_avg_comments_per_posts	int	Average of account comments per post
account_est_budget	int	Estimated account budget

Response

[
    {
        "post_date": "2022-09-08",
        "account": "zkdlin",
        "account_url": "https://instagram.com/zkdlin",
        "post": "@gucci @alessandro_michele \n@dazedkorea \n#gucci #exquisitegucci #dazedkorea",
        "post_url": "https://instagram.com/p/CiPaW3vPyhh",
        "type_of_payed": "sponsored",
        "post_er": "15.3%",
        "post_reach": 1852046,
        "post_performance": 4.824712,
        "post_likes": 2153321,
        "post_comments": 32257,
        "post_video_views": 0,
        "account_type": "Brand",
        "account_category": "Music",
        "account_is_verified": "yes",
        "account_followers": 14176040,
        "account_audience_country": "FR",
        "account_audience_region": "",
        "account_audience_age": "18-24",
        "account_audience_gender": "female",
        "account_aqs": 91,
        "account_er": "11.19%",
        "account_quality_audience": 11644199,
        "account_quality_audience_prc": "82.14%",
        "account_reach": 1852046,
        "total_accounts_posts": 3,
        "account_posts_performance": 0.714712,
        "account_avg_likes_per_posts": 1577801.7,
        "account_avg_comments_per_posts": 17218.3,
        "account_est_budget": "$119046.00"
    },
		...
]

Error codes

If an error occurs while processing the request, a corresponding message will be returned:

{
    "error": {
        "code": 103,
        "description": "Invalid user Id"
    }
}

Code	Description
8	Report not found
26	You do not have enough credits
27	You do not have API access
34	Account is suspended
103	Invalid user ID