Ylytic Documentation
  • Introduction
  • Platform Brief
  • Quick Start Guide
  • FAQs
    • About Ylytic
    • About Ylytic Data and Insights
    • About Ylytic Features and Pricing
  • REST APIs
    • API Overview
      • Third Party API
      • Campaign Tracking API
      • First Party API
      • Realtime Tracking API
      • Data Refresh API
      • Link Tracking API
      • Discovery Search API
      • Shopify Sales Tracking API
  • FEATURES
    • Creator Discovery
      • Discover
      • Select
      • Reachout
    • Creator Insights
      • Profile Overview
      • Audience
      • Engagement
      • Posting Activity
      • Mentions
    • Campaign Insights
      • Stats
      • Audience
      • Posts
    • Collections
    • Ylytic's Collection
    • Link Tracking
    • Shopify Sales Tracking
    • Whitelabel Platform
Powered by GitBook
On this page
  • POST – Create Data Refresh Request
  • payload
  • GET – Get Data Refresh Request
  1. REST APIs
  2. API Overview

Data Refresh API

Get Public data and insights (without Audience demographics) of a creator using their Instagram handle.

POST – Create Data Refresh Request

This API is used for refreshing the existing data of the creator.

curl --location 'https://dashboard.ylytic.com/ylytic/api/v1/data_refresh/requests' \
--header 'Authorization: Bearer {{auth_header}}' \
--data '{
    "request_type":"instagram",
    "handle":"thetatvaindia"
}'

payload

There are multiple combinations possible which are described below.

Value of "request_type"
second parameter name
SAMPLE DATA

instagram

handle

{

'request_type':'instagram',

'handle':'thetatvaindia'

}

instagram_id

ig_user_id

{

'request_type':'instagram_id',

'ig_user_id':'2121125346'

}

instagram_post

shortcode

{

'request_type':'instagram_post',

'shortcode':'DHGIoX0y3f3'

}

youtube

channel_id

{

'request_type':'youtube',

'channel_id':'UCurYxozQbvKn-oNUxNJh45Q'

}

youtube_post

video_id

{

'request_type':'youtube_post',

'video_id':'iwIeyWv2ABI'

}

Output (JSON)
{
    "request_id": "65b87c8576c9b42b3a285805",
    "request": {
        "request_type": "instagram",
        "handle": "thetatvaindia"
    },
    "response": null,
    "status": {
        "code": 201,
        "message": "pending",
        "request_at": "Tue, 30 Jan 2024 04:35:17 GMT",
        "response_at": null
    }
}

GET – Get Data Refresh Request

curl --location --request GET 'https://dashboard.ylytic.com/ylytic/api/v1/data_refresh/requests/{request_id}' \
--header 'Authorization: Bearer {{auth header}}'
Output (JSON)
{
    "request": {
        "handle": "handle_name",
        "request_type": "instagram"
},
    "request_id": "request_identifier",
    "response": {
        "growth_trends": {
            "engagement_trends": [
                {
                        "2023-12-01": {
                            "followers": 0.8
                        }
                },
                {
                        "2023-12-04": {
                            "followers": 0.7
                        }
                },
                {
                        "2023-12-06": {
                            "followers": 1.1
                        }
                }
            ],
            "followers_trends": [
                {
                        "2023-12-01": {
                            "followers": 750
                        }
                },
                {
                        "2023-12-04": {
                            "followers": 800
                        }
                },
                {
                        "2023-12-06": {
                            "followers": 1000
                        }
                }
            ],
            "monthly_engagement_growth": 0.54,
            "monthly_followers_growth": 0.07,
            "quaterly_engagement_growth": 0.69,
            "quaterly_followers_growth": -0.07,
            "yearly_engagement_growth": 0.42,
            "yearly_followers_growth": -3.23
        },
        "posts": {
            "non_video_posts": [
                {
                        "caption": "asdas",
                        "comments_count": 1,
                        "engagement": 1.01,
                        "external_links": [
                            "https://asdas.com"
                        ],
                        "hashtags": [
                            "#adsasd"
                        ],
                        "likes_count": 10,
                        "posted_date": "2023-12-03",
                        "raw_image_url":                           "https://instagram.com/images/askdnanla",
                        "shortcode": "asda",
                        "sponsored": false
                }
            ],
            "video_posts": [
                {
                        "caption": "hello world",
                        "comments_count": 12,
                        "engagement": 1.2,
                        "external_links": [
                                "https://asdas.com"
                        ],
                        "hashtags": [
                                "#worth",
                                "#ad"
                        ],
                        "likes_count": 24,
                        "posted_date": "2023-12-03",
                        "raw_image_url": "https://instagram.com/images/askdnanla",
                        "shortcode": "asdasd",
                        "sponsored": true,
                        "views": 123
                }
           ]
        },
        "profile_details": {
                "biography": "Co-Founder of Ylytic",
                "brand_mentions": [
                "@oi"
                ],
                "category": "Business & Entrepreneurship",
                "city": "Pune",
                "country": "India",
                "email": "anurag@ylytic.com",
                "external_links": [
                "https://www.ylytic.com"
                ],
                "full_name": "Anurag Gupta",
                "hashtags": [
                "#growwithylytic"
                ],
                "ig_category": "Business",
                "mentions": [
                "@mradulsharna"
                ],
                "mobile": "9028055113",
                "raw_image_url": "https://instagram.com/images/askdnanla"
        },
        "profile_overview": {
                "content_per_week": 1.2,
                "engagement": 1.1,
                "followers_count": 10001,
                "following_count": 200,
                "handle": "anurag.itbhu05",
                "ig_user_id": "123456",
                "influencer_tier": "nano",
                "post_count": 10
        },
        "reach_and_engagement_details": {}
        },
        "status": {
                "code": 200,
                "message": "success",
                "request_at": "Wed, 06 Dec 2023 06:09:37 GMT",
                "response_at": "Wed, 06 Dec 2023 06:09:47 GMT"
        }
}

PreviousRealtime Tracking APINextLink Tracking API

Last updated 2 months ago