HypeAuditor For Snapchat
Endpoint
Get the report of a Snapchat channel:
GET https://hypeauditor.com/api/method/auditor.snapchat/?channel={channel}
Channel is Snapchat username (nasa) from the url of Snapchat channel (https://www.snapchat.com/add/nasa).
Returns the report if it’s ready or requests the report if it’s not ready. First check of the username costs 1 credit and the report will be accessible for 1 year. Note: Next check after 365 days will also cost 1 credit.
Note:
nasareport is free, use it to test the API.
Changelog
Important:
- Snapchat Report has added to HypeAuditor API since 31/08/2023.
Error codes
You will receive error if requested channel is not found, has no videos or no views.
CHANNEL_NOT_FOUNDchannel not found on SnapchatREPORT_CALCULATINGcome back later
Response Object
| Attributes | Type | |
|---|---|---|
| report | object | Snapchat report data |
Report Object
| Attributes | Type | |
|---|---|---|
| basic | object | general information about the channel |
| metrics | object | channel metrics and calculated metrics |
| features | object | rich data about channel |
Basic Object
| Attributes | Type | |
|---|---|---|
| id | string | channel id |
| username | string | channel username |
| title | string | channel title |
| avatar_url | string | channel avatar url |
| description | string | channel description |
Metrics Object
Each metric object may contain value field and performance object. Performance object contains 3 periods of data: (30d for 30 days, 90d for 90 days, and 180d for 180 days). Each period object may contain value computed for current period (30/90/180d).
subscribers_count
| Attributes | Type | |
|---|---|---|
| value | int | Number of total subscribers |
| performance.value | int | number of new subscribers in a given period |
subscribers_growth_prc
| Attributes | Type | |
|---|---|---|
| performance.value | float | value in a given period |
| performance.mark | string | quality mark |
| performance.similar | float | value for similar accounts in a given period |
Marks:
poorfairaveragegoodexcellent
views_count
| Attributes | Type | |
|---|---|---|
| value | int | value of views count |
| mark | string | quality mark |
| similar | sint | value for similar accounts |
| performance.value | float | value in a given period |
| performance.mark | string | quality mark in a given period |
| performance.similar | float | value for similar accounts in a given period |
views_avg
| Attributes | Type | |
|---|---|---|
| value | int | value of views average |
| performance.value | int | value in a given period |
| performance.min | int | max. value in a given period |
| performance.max | int | min. value in a given period |
media_count
| Attributes | Type | |
|---|---|---|
| performance.value | int | value in a given period |
media_per_week
| Attributes | Type | |
|---|---|---|
| performance.value | int | value in a given period |
Features Object
most_media
Lists of most media ids. Object media_ids includes spotlights , snaps and all. Each media_ids object contains sorting by views_desc and time_posted_desc where performance object is included for given periods.
| Attributes | Type | |
|---|---|---|
| data.media_ids.{media_type}.views_desc | object with array of media_ids | Media IDs desc. sorted by views |
| data.media_ids.{media_type}.time_posted_desc | object with array of media_ids | Media IDs desc. sorted by time posted |
| data.media_ids.{media_type}.{sort}.performance.{period}.media_ids | Array of media_ids | Media IDs |
blogger_emails
List of blogger contact emails
| Attributes | Type | |
|---|---|---|
| data | array | array of emails. |
blogger_geo
Blogger geo if available
| Attributes | Type | |
|---|---|---|
| data.country | string | ISO Alpha-2 two letter country code. |
| data.city | int | city id from https://www.geonames.org |
| data.state | int | state id from https://www.geonames.org |
blogger_languages
| Attributes | Type | |
|---|---|---|
| data | array | array of 2 letter lang codes |
blogger_hashtags
blogger_hashtags object contains performance object for given periods
| Attributes | Type | |
|---|---|---|
| data.performance.{period} | array | array of hashtag objects {text: string, media_count: int, er_avg: float} |
social_networks
| Attributes | Type | |
|---|---|---|
| data | array | array of {type: int, id: string} objects. |
Social networks ids map:
| Id | Social network |
|---|---|
| 1 | |
| 2 | YouTube |
| 3 | TikTok |
| 4 | Twitch |
| 5 | |
| 7 | Snapchat |
Requests
Set YOUR_ID and YOUR_TOKEN from HypeAuditor.
curl -X POST \
https://hypeauditor.com/api/method/auditor.snapchat \
-H 'content-type: application/x-www-form-urlencoded' \
-H 'x-auth-id: %YOUR_ID%' \
-H 'x-auth-token: %YOUR_TOKEN%' \
-d channel=nasa \
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://hypeauditor.com/api/method/auditor.snapchat',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => [
'channel' => 'nasa'
],
CURLOPT_HTTPHEADER => [
'x-auth-id: YOUR_ID',
'x-auth-token: YOUR_TOKEN'
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo 'cURL Error #:' . $err;
} else {
echo $response;
}
Note:
You don’t need to pre-request the report from web, you can request it directly from API.
Sample request
GET https://hypeauditor.com/api/method/auditor.snapchat/?channel=nasa
Sample response
{
"result": {
"report": {
"basic": {
"id": "nasa",
"username": "nasa",
"title": "NASA",
"avatar_url": "https://cf-st.sc-cdn.net/aps/bolt/aHR0cHM6Ly9jZi1zdC5zYy1jZG4ubmV0L2QvUVg2VHZkaDBHNUMzcXVidWhWaTJhP2JvPUVnMGFBQm9BTWdFRVNBSlFHV0FCJnVjPTI1._RS0,90_FMjpeg",
"description": "Explore the universe and discover our home planet with official NASA snaps."
},
"metrics": {
"subscribers_count": {
"value": 829000,
"performance": {
"30d": {
"value": 0
},
"90d": {
"value": 0
},
"180d": {
"value": 0
}
}
},
"subscribers_growth_prc": {
"performance": {
"30d": {
"value": 0,
"mark": "fair",
"similar": 0.280833
},
"90d": {
"value": 0,
"mark": "fair",
"similar": 0.280833
},
"180d": {
"value": 0,
"mark": "fair",
"similar": 0.280833
}
}
},
"views_count": {
"value": 0,
"mark": "poor",
"similar": 75,
"performance": {
"30d": {
"value": 0,
"mark": "poor",
"similar": 27199
},
"90d": {
"value": 0,
"mark": "poor",
"similar": 89880
},
"180d": {
"value": 0,
"mark": "poor",
"similar": 158037
}
}
},
"views_avg": {
"value": 0,
"performance": {
"30d": {
"value": 0,
"min": null,
"max": null
},
"90d": {
"value": 0,
"min": null,
"max": null
},
"180d": {
"value": 0,
"min": null,
"max": null
}
}
},
"media_count": {
"performance": {
"30d": {
"value": 0
},
"90d": {
"value": 12
},
"180d": {
"value": 12
}
}
},
"media_per_week": {
"performance": {
"30d": {
"value": 0
},
"90d": {
"value": 1
},
"180d": {
"value": 0
}
}
}
},
"features": {
"most_media": {
"data": {
"media_ids": {
"spotlights": {
"views_desc": {
"performance": {
"30d": {
"media_ids": []
},
"90d": {
"media_ids": []
},
"180d": {
"media_ids": []
}
}
},
"time_posted_desc": {
"performance": {
"30d": {
"media_ids": []
},
"90d": {
"media_ids": []
},
"180d": {
"media_ids": []
}
}
}
},
"snaps": {
"views_desc": {
"performance": []
},
"time_posted_desc": {
"performance": {
"30d": {
"media_ids": []
},
"90d": {
"media_ids": [
"1685113667_0",
"1685113667_1",
"1685113667_2",
"1685113667_3",
"1685113667_4",
"1685113667_5",
"1685113667_6",
"1685113667_7"
]
},
"180d": {
"media_ids": [
"1685113667_0",
"1685113667_1",
"1685113667_2",
"1685113667_3",
"1685113667_4",
"1685113667_5",
"1685113667_6",
"1685113667_7"
]
}
}
}
},
"all": {
"views_desc": {
"performance": {
"30d": {
"media_ids": []
},
"90d": {
"media_ids": []
},
"180d": {
"media_ids": []
}
}
},
"time_posted_desc": {
"performance": {
"30d": {
"media_ids": []
},
"90d": {
"media_ids": [
"1685113667_0",
"1685113667_1",
"1685113667_2",
"1685113667_3",
"1685113667_4",
"1685113667_5",
"1685113667_6",
"1685113667_7"
]
},
"180d": {
"media_ids": [
"1685113667_0",
"1685113667_1",
"1685113667_2",
"1685113667_3",
"1685113667_4",
"1685113667_5",
"1685113667_6",
"1685113667_7"
]
}
}
}
}
}
}
},
"blogger_emails": {
"data": null
},
"blogger_geo": {
"data": null
},
"blogger_languages": {
"data": [
"en"
]
},
"blogger_hashtags": {
"data": null
},
"social_networks": {
"data": [
{
"type": 7,
"id": "nasa"
},
{
"type": 1,
"id": "8_n20"
}
]
}
}
},
"restTokens": 871
}
}
highDemand field is “true” when HypeAuditor experiences unexpected high load that effects report generation time negatively. When you receive that field you may want to inform your users that the delay is temporary and we’re fixing it. Everything will go back to normal and all requests are safe.