Shopify Sales Tracking API
Get sales generated through influencer marketing on Shopify. This API can be used to track Shopify orders and monitor clicks, conversions, and overall sales generated from specific influencers.
POST - Add New Shopify Store
This API is used for adding a new Shopify Store.
curl --location 'https://dashboard.ylytic.com/ylytic/admin/api/v1/shopify_shop' \
--header 'Authorization: Bearer {{auth_header}}' \
--data '{
"shop":"storename.myshopify.com",
"access_token":"bcf90967-774b-44b6-b477-c3895849"
}'POST PARAM
| ATTRIBUTES | DESCRIPTION |
|---|---|
shop | The name of the Shopify store |
access_token | The Admin API Access Token is available on the Shopify store Dev apps |
PAYLOAD
{
"shop":"storename.myshopify.com",
"access_token":"bcf90967-774b-44b6-b477-c3895849"
}OUTPUT(JSON)
{"status":"success"}POST - Create Shortlinks for Shopify Sales Tracking
curl --location 'https://dashboard.ylytic.com/ylytic/admin/api/v1/shortlinks' \
--header 'Authorization: Bearer <token>' \
--data '{
"target_url":"https://docs.ylytic.com/ylytic",
"name":"test",
"shopify_store_name":"storename.myshopify.com",
"utm_source":"anurag"
}'| ATTRIBUTES | DESCRIPTION |
|---|---|
target_url | URL of which the shortlink has to be created. |
name | The name of the shortlink |
shopify_store_name | The name of the shopify store |
utm_source | The unique identification of the source (influencer) |
PAYLOAD
{
"name": "test",
"target_url": "https://docs.ylytic.com/ylytic",
"shopify_store_name": "storename.myshopify.com",
"utm_source": "anurag"
}PATCH - Add/Remove shortlinks in the campaign for Shopify Sales Tracking
curl --location --request PATCH 'https://dashboard.ylytic.com/ylytic/admin/api/v1/campaigns/65c07f7cc274480601165274' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"add_shortlinks": [
{"post_url":"https://www.instagram.com/reels/C295JByPmDT/",
"shortlink":["shortlink_1","shortlink_2"]}
],
"remove_shortlinks": []
}'| ATTRIBUTES | DESCRIPTION |
|---|---|
post_url | URL of the post in the campaign corresponding to which the short link is created |
shortlink | URLs of the short links generated corresponding to the influencer creating the post/content in the campaign |
PAYLOAD
{
"add_shortlinks": [
{"post_url":"https://www.instagram.com/reels/C295JByPmDT/",
"shortlink":["shortlink_1","shortlink_2"]
],
"remove_shortlinks": []
}GET - Campaign Insights with Shopify Sales Tracking
This API is used to get insights of the campaign that includes shortlinks for Shopify Sales Tracking.
curl --location 'https://insights.ylytic.com/ylytic/api/v1/insights/campaigns/65b74956dd8a4714ed541da8?key=bcf90967-774b-44b6-b477-c31147c16299' \
--header 'Authorization: Bearer {{auth_header}}'OUTPUT(JSON)
{
"status": "live",
"share_url": "https://insights.ylytic.com/campaign?id=65b74956dd8a4714ed541da8",
"start_date": null,
"connectors": [
"instagram"
],
"posts_count": 1,
"creators_count": 1,
"reach": 51096,
"views": 56774,
"followers": 1257,
"comments": 29,
"likes": 3023,
"engagement": 3052,
"er": 242.8,
"erv": 5.38,
"top_posts": [
{
"connector": "instagram",
"shortcode": "C2i51IIITd4",
"comments_count": 29,
"likes_count": 3023,
"post_type": "REEL",
"title": "राष्ट्रध्वजाचा सन्मान म्हणजे देशाचा सन्मान ! \n\nText By: 💁♂️\nCalligraphy: @bhaktigoswamii \nThank you: @seemanikam_ @shubham_kakade_1 @i_am_swatiiii_ @abhishek_amate @its_me_sakshiiii \n\n#republicday #Indianrepublicday #26january #respecttheindianflag #tiranga #tiranga🇮🇳 #tiranga #marathiquotes #fcroadpune #seriouscontent #trendingreels #trend #nationallove #reelsindia #indian #indianbride",
"description": "राष्ट्रध्वजाचा सन्मान म्हणजे देशाचा सन्मान ! \n\nText By: 💁♂️\nCalligraphy: @bhaktigoswamii \nThank you: @seemanikam_ @shubham_kakade_1 @i_am_swatiiii_ @abhishek_amate @its_me_sakshiiii \n\n#republicday #Indianrepublicday #26january #respecttheindianflag #tiranga #tiranga🇮🇳 #tiranga #marathiquotes #fcroadpune #seriouscontent #trendingreels #trend #nationallove #reelsindia #indian #indianbride",
"hashtags": [
"#republicday",
"#Indianrepublicday",
"#26january",
"#respecttheindianflag",
"#tiranga",
"#tiranga🇮🇳",
"#tiranga",
"#marathiquotes",
"#fcroadpune",
"#seriouscontent",
"#trendingreels",
"#trend",
"#nationallove",
"#reelsindia",
"#indian",
"#indianbride"
],
"creator": {
"handle": "a_poetic_storyteller",
"url": "https://www.instagram.com/a_poetic_storyteller",
"full_name": "Ratnadeep Mahadev Shinde",
"follower_count": 1257,
"media_count": 89,
"connector": "instagram"
},
"shortlinks_analysis": {
"affiliate_orders_count": 2,
"affiliate_orders_amount": 0,
"orders": [
{
"order_id": "5734128648411",
"products": [
{
"id": "8081454399707",
"name": "Ylytic Campaign Tracking",
"price": "0.00",
"quantity": 1
}
]
},
{
"order_id": "5734128484571",
"products": [
{
"id": "8081453777115",
"name": "Ylytic Discovery",
"price": "0.00",
"quantity": 1
}
]
}
],
"users": 1,
"clicks": 1,
"city_distribution": [
{
"city": null,
"users": 1,
"clicks": 1
}
],
"country_distribution": [
{
"country": null,
"users": 1,
"clicks": 1
}
],
"platform_distribution": [
{
"platform": null,
"users": 1,
"clicks": 1
}
],
"device_distribution": [
{
"device": null,
"users": 1,
"clicks": 1
}
],
"date_distribution": [
{
"date": "2024-05-21",
"users": 1,
"clicks": 1,
"affiliate_orders_count": 2,
"affiliate_orders_amount": 0
}
]
},
"posted_date": "Fri, 26 Jan 2024 01:44:55 GMT",
"post_url": "https://www.instagram.com/p/C2i51IIITd4/",
"image_url": "https://instagram.ftll2-1.fna.fbcdn.net/v/t51.2885-15/422016103_3896545190569009_6748496429880636579_n.jpg?stp=c0.280.720.720a_dst-jpg_e15_s640x640&_nc_ht=instagram.ftll2-1.fna.fbcdn.net&_nc_cat=101&_nc_ohc=28qtkkk8SsMAX9Ju7j3&edm=AP_V10EBAAAA&ccb=7-5&oh=00_AfAwrSofOOeSwDZLjVwG35lgPzEFw4C5zPptbbxVub18Yg&oe=65BA6065&_nc_sid=2999b8",
"display_url": "https://s3.ap-south-1.amazonaws.com/nudges//tmp/C2i51IIITd4.jpg",
"reach": 51096,
"views": 56774,
"er": 242.8,
"comments": [
{
"text": "भाऊ खिशाचा झेंडा सातवित होतो तेव्हा घेतलेला2002 ला आजून संभाळून ठेवलाय आता माझा मुलगा लावतो दिड वर्षाचा आहे तो🇮🇳",
"created_at": 1706507686,
"sentiment": 0,
"like_count": "",
"commenter": "bhosale7765"
},
{
"text": "खरच भाऊ... आणि फेकताना यांना लाज कशीनसल वाटत...🤬😠",
"created_at": 1706447740,
"sentiment": 0,
"like_count": "",
"commenter": "mayu_jagtap_07"
}
],
"commentors": [
{
"username": "bhosale7765",
"connector": "instagram"
},
{
"username": "mayu_jagtap_07",
"connector": "instagram"
},
],
"refresh_date": "Tue, 30 Jan 2024 04:07:46 GMT"
}
],
"posts": [
{
"connector": "instagram",
"shortcode": "C2i51IIITd4",
"comments_count": 29,
"likes_count": 3023,
"post_type": "REEL",
"title": "राष्ट्रध्वजाचा सन्मान म्हणजे देशाचा सन्मान ! \n\nText By: 💁♂️\nCalligraphy: @bhaktigoswamii \nThank you: @seemanikam_ @shubham_kakade_1 @i_am_swatiiii_ @abhishek_amate @its_me_sakshiiii \n\n#republicday #Indianrepublicday #26january #respecttheindianflag #tiranga #tiranga🇮🇳 #tiranga #marathiquotes #fcroadpune #seriouscontent #trendingreels #trend #nationallove #reelsindia #indian #indianbride",
"description": "राष्ट्रध्वजाचा सन्मान म्हणजे देशाचा सन्मान ! \n\nText By: 💁♂️\nCalligraphy: @bhaktigoswamii \nThank you: @seemanikam_ @shubham_kakade_1 @i_am_swatiiii_ @abhishek_amate @its_me_sakshiiii \n\n#republicday #Indianrepublicday #26january #respecttheindianflag #tiranga #tiranga🇮🇳 #tiranga #marathiquotes #fcroadpune #seriouscontent #trendingreels #trend #nationallove #reelsindia #indian #indianbride",
"hashtags": [
"#republicday",
"#Indianrepublicday",
"#26january",
"#respecttheindianflag",
"#tiranga",
"#tiranga🇮🇳",
"#tiranga",
"#marathiquotes",
"#fcroadpune",
"#seriouscontent",
"#trendingreels",
"#trend",
"#nationallove",
"#reelsindia",
"#indian",
"#indianbride"
],
"creator": {
"handle": "a_poetic_storyteller",
"url": "https://www.instagram.com/a_poetic_storyteller",
"full_name": "Ratnadeep Mahadev Shinde",
"follower_count": 1257,
"media_count": 89,
"connector": "instagram"
},
"shortlinks_analysis": {
"affiliate_orders_count": 2,
"affiliate_orders_amount": 0,
"orders": [
{
"order_id": "5734128648411",
"products": [
{
"id": "8081454399707",
"name": "Ylytic Campaign Tracking",
"price": "0.00",
"quantity": 1
}
]
},
{
"order_id": "5734128484571",
"products": [
{
"id": "8081453777115",
"name": "Ylytic Discovery",
"price": "0.00",
"quantity": 1
}
]
}
],
"users": 1,
"clicks": 1,
"city_distribution": [
{
"city": null,
"users": 1,
"clicks": 1
}
],
"country_distribution": [
{
"country": null,
"users": 1,
"clicks": 1
}
],
"platform_distribution": [
{
"platform": null,
"users": 1,
"clicks": 1
}
],
"device_distribution": [
{
"device": null,
"users": 1,
"clicks": 1
}
],
"date_distribution": [
{
"date": "2024-05-21",
"users": 1,
"clicks": 1,
"affiliate_orders_count": 2,
"affiliate_orders_amount": 0
}
]
},
"posted_date": "Fri, 26 Jan 2024 01:44:55 GMT",
"post_url": "https://www.instagram.com/p/C2i51IIITd4/",
"image_url": "https://instagram.ftll2-1.fna.fbcdn.net/v/t51.2885-15/422016103_3896545190569009_6748496429880636579_n.jpg?stp=c0.280.720.720a_dst-jpg_e15_s640x640&_nc_ht=instagram.ftll2-1.fna.fbcdn.net&_nc_cat=101&_nc_ohc=28qtkkk8SsMAX9Ju7j3&edm=AP_V10EBAAAA&ccb=7-5&oh=00_AfAwrSofOOeSwDZLjVwG35lgPzEFw4C5zPptbbxVub18Yg&oe=65BA6065&_nc_sid=2999b8",
"display_url": "https://s3.ap-south-1.amazonaws.com/nudges//tmp/C2i51IIITd4.jpg",
"reach": 51096,
"views": 56774,
"er": 242.8,
"comments": [
{
"text": "भाऊ खिशाचा झेंडा सातवित होतो तेव्हा घेतलेला2002 ला आजून संभाळून ठेवलाय आता माझा मुलगा लावतो दिड वर्षाचा आहे तो🇮🇳",
"created_at": 1706507686,
"sentiment": 0,
"like_count": "",
"commenter": "bhosale7765"
},
{
"text": "खरच भाऊ... आणि फेकताना यांना लाज कशीनसल वाटत...🤬😠",
"created_at": 1706447740,
"sentiment": 0,
"like_count": "",
"commenter": "mayu_jagtap_07"
}
],
"commentors": [
{
"username": "bhosale7765",
"connector": "instagram"
},
{
"username": "mayu_jagtap_07",
"connector": "instagram"
},
{
"username": "sayalii_sonule",
"connector": "instagram"
},
{
"username": "oldschool_840",
"connector": "instagram"
},
{
"username": "samruddhi_deshpande1",
"connector": "instagram"
},
{
"username": "vaibhavi.vs",
"connector": "instagram"
},
{
"username": "saurabbhhhhhh",
"connector": "instagram"
},
{
"username": "seemanikam_",
"connector": "instagram"
},
{
"username": "rsherkhane5666",
"connector": "instagram"
},
{
"username": "virajthorat_4554",
"connector": "instagram"
},
{
"username": "marathi_mavla_1997",
"connector": "instagram"
},
{
"username": "shrinivasmunde73",
"connector": "instagram"
},
{
"username": "aniketp166",
"connector": "instagram"
},
{
"username": "rupalsp",
"connector": "instagram"
},
{
"username": "hemangi___",
"connector": "instagram"
}
],
"refresh_date": "Tue, 30 Jan 2024 04:07:46 GMT"
}
],
"all_comments": [
{
"text": "भाऊ खिशाचा झेंडा सातवित होतो तेव्हा घेतलेला2002 ला आजून संभाळून ठेवलाय आता माझा मुलगा लावतो दिड वर्षाचा आहे तो🇮🇳",
"created_at": 1706507686,
"sentiment": 0,
"like_count": "",
"commenter": "bhosale7765"
},
{
"text": "खरच भाऊ... आणि फेकताना यांना लाज कशीनसल वाटत...🤬😠",
"created_at": 1706447740,
"sentiment": 0,
"like_count": "",
"commenter": "mayu_jagtap_07"
}
],
"word_cloud": [
{
"text": "भाऊ",
"value": 2
},
{
"text": "खिशाचा",
"value": 1
},
{
"text": "झेंडा",
"value": 1
},
{
"text": "सातवित",
"value": 1
},
{
"text": "होतो",
"value": 1
},
{
"text": "तेव्हा",
"value": 1
},
{
"text": "घेतलेला2002",
"value": 1
},
{
"text": "ला",
"value": 1
},
{
"text": "आजून",
"value": 1
},
{
"text": "संभाळून",
"value": 1
},
{
"text": "ठेवलाय",
"value": 1
},
{
"text": "आता",
"value": 1
},
{
"text": "माझा",
"value": 1
},
{
"text": "मुलगा",
"value": 1
},
{
"text": "लावतो",
"value": 1
},
{
"text": "दिड",
"value": 1
},
{
"text": "वर्षाचा",
"value": 1
},
{
"text": "आहे",
"value": 1
},
{
"text": "तो",
"value": 1
},
{
"text": "खरच",
"value": 1
},
{
"text": "आणि",
"value": 1
},
{
"text": "फेकताना",
"value": 1
},
{
"text": "यांना",
"value": 1
},
{
"text": "लाज",
"value": 1
},
{
"text": "कशीनसल",
"value": 1
},
{
"text": "वाटत",
"value": 1
}
],
"age_gender_distribution": {
"13-17": {
"male": 1.6,
"female": 1.4
},
"18-24": {
"male": 9.1,
"female": 12.9
},
"25-34": {
"male": 40.6,
"female": 9.4
},
"35-44": {
"male": 13.6,
"female": 8.4
},
"45-54": {
"male": 1.1,
"female": 0.9
},
"55-64": {
"male": 0.6,
"female": 0.4
},
"65-": {
"male": 0.0,
"female": 0.0
}
},
"audience": {
"age_group_distribution": {
"13-17": 3.0,
"18-24": 22.0,
"25-34": 50.0,
"35-44": 22.0,
"45-54": 2.0,
"55-64": 1.0,
"65-": 0.0
},
"age_gender_distribution": {
"13-17": {
"male": 1.6,
"female": 1.4
},
"18-24": {
"male": 9.1,
"female": 12.9
},
"25-34": {
"male": 40.6,
"female": 9.4
},
"35-44": {
"male": 13.6,
"female": 8.4
},
"45-54": {
"male": 1.1,
"female": 0.9
},
"55-64": {
"male": 0.6,
"female": 0.4
},
"65-": {
"male": 0.0,
"female": 0.0
}
},
"gender_distribution": {
"male": 66.6,
"female": 33.4
},
"city_distribution": {
"Delhi": 28.57,
"Mumbai": 28.57,
"Pune": 14.29,
"Hyderabad": 14.29,
"Kolkata": 14.29
},
"top": {
"gender": "Male",
"gender_per": 66.6,
"age_group": "25-34",
"age_group_per": 50.0,
"location": "Delhi",
"location_per": 28.57,
"country": "India"
},
"comments_sentiment_analysis": {
"comments": [
{
"text": "भाऊ खिशाचा झेंडा सातवित होतो तेव्हा घेतलेला2002 ला आजून संभाळून ठेवलाय आता माझा मुलगा लावतो दिड वर्षाचा आहे तो🇮🇳",
"created_at": 1706507686,
"sentiment": 0,
"like_count": "",
"commenter": "bhosale7765"
},
{
"text": "खरच भाऊ... आणि फेकताना यांना लाज कशीनसल वाटत...🤬😠",
"created_at": 1706447740,
"sentiment": 0,
"like_count": "",
"commenter": "mayu_jagtap_07"
}
],
"total_comments": 2,
"sentiment": {
"positives": 0,
"negatives": 0,
"neutral": 100
},
"word_cloud": [
{
"text": "आणि",
"value": 1
},
{
"text": "फेकताना",
"value": 1
},
{
"text": "यांना",
"value": 1
},
{
"text": "लाज",
"value": 1
},
{
"text": "कशीनसल",
"value": 1
},
{
"text": "वाटत",
"value": 1
}
]
}
},
"reach_trends": [
{
"2024-01-29": {
"reach": 693889
}
},
{
"2024-01-30": {
"reach": 1629764
}
}
],
"engagement_trends": [
{
"2024-01-29": {
"engagement": 0.95
}
},
{
"2024-01-30": {
"engagement": 0.17
}
}
],
"views_trends": [
{
"2024-01-29": {
"views": 770988
}
},
{
"2024-01-30": {
"views": 1810849
}
}
],
"cumulative_engagement_trends": [
{
"2024-01-29": {
"engagement": 17879
}
},
{
"2024-01-30": {
"engagement": 25900
}
}
],
"cumulative_erv_trends": [
{
"2024-01-29": {
"erv": [
2.32
]
}
},
{
"2024-01-30": {
"erv": [
1.43
]
}
}
],
"hashtag_insights": null,
"hashtag_overview": {
"total_reach": 0,
"total_post_count": 0,
"total_views": 0,
"cpr": 0,
"cpv": 0
},
"hashtags": [
"#fcroadpune",
"#indianbride",
"#marathiquotes",
"#trendingreels",
"#26january",
"#respecttheindianflag",
"#tiranga🇮🇳",
"#nationallove",
"#Indianrepublicday",
"#trend",
"#seriouscontent",
"#tiranga",
"#indian",
"#republicday",
"#reelsindia"
],
"cost_of_campaign": 0,
"custom_field_name": null,
"custom_field_value": null,
"name": "29/01/24_test_camp",
"brand_name": "xyz",
"brand_logo_url": "https://img.icons8.com/ios/512/no-image.png",
"client_name": "Anurag Gupta",
"client_logo_url": "https://ylytic.s3.ap-south-1.amazonaws.com/uploads/fd4ebe51-b12d-42cd-93dd-0d70aaadf1fa.png",
"insights_link": "https://insights.ylytic.com/campaign?id=65b74956dd8a4714ed541da8",
"threshold_reach": null,
"threshold_er": null
}Last updated