Download OpenAPI specification:Download
The official API to manage Instaon campaigns and assets. Please contact us via our Instaon Partner Program for more information and getting whitelisted.
Th API allows you to register a Instaon user and build optimized marketing campaigns. Once a user has been authenticated over the api, you can add business information and start creating campaigns. Marketing campaigns are published to platforms (Google, Facebook, Microsoft, ..) with different goals (Get calls, get website traffic etc..). To publish a given campaign, all required features have to be added to a campaign.
API calls to register a user in order to obtain a bearer token. Bearer token must be added to every request in order to be able to access personnal data.
Content-Type required | string Example: application/x-www-form-urlencoded |
client_id required | integer <int32> |
client_secret required | string |
grant_type required | string |
password required | string |
scope required | string |
username required | string |
client_id required | integer <int32> Example: client_id=75 |
redirect_uri required | string Example: redirect_uri=https://dev.instaon.io/app |
response_type required | string Example: response_type=token code or token |
scope required | string |
state required | integer <int32> Example: state=25435353 {{$randomAlphaNumeric}} |
email required | string |
password required | string |
Activate or deactivate auto-billing for a business. Auto-billed businesses will have new credits automatically billed when they reach zero balance.
active required | boolean |
{- "active": false
}
Initiate a Stripe transaction for the user to add credit to his account. User will have to redirect to Stripe to authorize the transaction if this is his first time payment.
amount required | integer <int32> Example: 123 Amount in euros |
product required | integer <int32> Example: 10 Set product type to 10 to add credits |
publish_campaign_id required | string Example: publish_campaign_id={{test_campaign_id}} optional, publish campaign directly if payment succeed |
return_url required | string Example: return_url={{app_url}} |
Initiate a PayPal transaction for the user to add credit to his account. User will have to redirect to PayPal to authorize the transaction.
amount required | integer <int32> Example: 20 |
product required | integer <int32> Example: 10 |
return_url required | string Example: return_url={{app_url}} |
[- {
- "id": 1,
- "list_name": "List 1",
- "products": [
- {
- "id": 1,
- "title": "Green Mask",
- "description": "This green mask is cool, don't you like it?",
- "price": 5,
- "price_currency": "EUR",
- "stock": 5,
- "image": { },
- "product_page": { },
- "brand": "Instaon Fancy Masks",
- "category": ""
}, - {
- "id": 2,
- "title": "Green Mask",
- "description": "This green mask is cool, don't you like it?",
- "price": 5,
- "price_currency": "EUR",
- "stock": 5,
- "image": { },
- "product_page": { },
- "brand": "Instaon Fancy Masks",
- "category": ""
}
]
}, - {
- "id": 2,
- "list_name": "List 1",
- "products": [ ]
}
]
List of customers associated to a Business. Can be used for re-marketing or other purposes
Replace all customers in a customer list
customerListId required | string |
stringarray |
{- "customers": [
- {
- "first_name": "Joh2",
- "last_name": "Doe",
- "email": "john@doe.com"
}, - {
- "first_name": "Alice",
- "last_name": "Bobson",
- "email": "alice.bobson@example.org"
}
]
}
Add new customers to an existing customer list
customerListId required | string |
{- "customers": [
- {
- "first_name": "Eve",
- "last_name": "Doe",
- "email": "eve@doe.com"
}
]
}
campaignId required | string Example: {{test_campaign_id}} |
interests required | Array of strings |
language required | string |
locations required | Array of strings |
required | Array of objects (LocationsArea) |
required | Array of objects (LocationsCountry) |
{- "language": "1000",
- "locations": [ ],
- "locations_areas": [
- {
- "google_place_id": "ChIJadawrk9svhQRClkG9xjiplE",
- "name": "Bodrum, Muğla, Türkiye",
- "lat": 37.034407,
- "lng": 27.43054,
- "units": "km",
- "radius": 40
}
], - "locations_countries": [
- {
- "google_place_id": "ChIJcSZPllwVsBQRKl9iKtTb2UA",
- "name": "Turkey",
- "lat": 38.963745,
- "lng": 35.243322,
- "short_name": "BE"
}
], - "interests": [ ]
}
campaignId required | string Example: {{test_campaign_id}} |
required | Array of objects (Area) |
required | Array of objects (Country) |
{- "areas": [
- {
- "google_place_id": "ChIJa76xwh5ymkcRW-WRjmtd6HU",
- "lat": 49.8503,
- "lng": 4.0517,
- "radius": 15,
- "units": "km",
- "name": "Paris"
}, - {
- "google_place_id": "ChIJa76xwh5ymkcRW-WRjmtd6HU",
- "lat": 50.8503,
- "lng": 4.3517,
- "radius": 10,
- "units": "km",
- "name": "Brussels"
}
], - "countries": [
- {
- "google_place_id": "ChIJa76xwh5ymkcRW-WRjmtd6HU",
- "lat": 50.8503,
- "lng": 4.3517,
- "name": "France",
- "short_name": "FR"
}
]
}
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
phone_number required | string phone number of the business to advertize |
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
platform_page_id required | integer <int64> |
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
description required | string |
url required | string |
Content-Type required | string Example: application/x-www-form-urlencoded |
business_id required | integer <int32> Give the business id you want to make a campaign for |
goal_type required | integer <int32> Give a goal type.: WEB_TRAFFIC = 0; LEADS_CALLS = 1; ONLINE_SALES = 2; OFFLINE_VISITORS = 3; CHAT_MESSAGES = 4; |
platform_code required | integer <int32> Set platform type: 0 = Google, 1 = Bing, 2 = Facebook |
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
network_type required | integer <int32> 0 = Search, 1 = Display, 2 = Shopping |
platform_code required | integer <int32> 0 = Google, 1 = Bing, 2 = Facebook |
Update campaign
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
goal required | integer <int32> |
Post choice of initial list of keywords for user validation
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/json |
business_name required | string |
descriptions[0] required | string |
headlines[0] required | string |
headlines[1] required | string |
images[0] required | integer <int32> Te id of the media you would like to add to the ad template |
long_headline required | string |
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
description required | string 1 to 90 characters |
title1 required | string 1 to 30 characters |
title2 required | string 1 to 30 characters |
title3 required | string 1 to 30 characters. Optional. |
Get initial list of keywords for user validation
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/json |
keywords[0] required | string |
keywords[1] required | string |
keywords[2] required | string |
Post choice of initial list of keywords for user validation
campaignId required | string Example: {{test_campaign_id}} |
required | Array of objects (KeywordTable) |
{- "keywordTable": [
- {
- "keyword": "watch now",
- "chosen": 1
}, - {
- "keyword": "abc news channel ",
- "chosen": 1
}, - {
- "keyword": "abc news channel ",
- "chosen": 1
}, - {
- "keyword": "watch series online free streaming",
- "chosen": 0
}, - {
- "keyword": "stream watch abc",
- "chosen": 1
}
]
}
campaignId required | string Example: {{test_campaign_id}} |
Content-Type required | string Example: application/x-www-form-urlencoded |
status required | string status can be ENABLED or PAUSED |
campaignId required | string Example: {{test_campaign_id}} |
keywordsToAdd required | Array of strings |
keywordsToRemove required | Array of strings |
{- "keywordsToAdd": [
- "abc app",
- "abc app chromecast",
- "abc showtimes",
- "christmas decoration tv show",
- "abc saturday night schedule",
- "wabc local news"
], - "keywordsToRemove": [
- "abc dancing with the stars live streaming online",
- "abc news live stream app"
]
}
campaignId required | string Example: {{test_campaign_id}} |
{- "data": {
- "sentences": [
- "Centro de ajuda",
- "Что вы хотели бы получить:",
- "Das am besten zu Ihnen passt",
- "Vous êtes en bonne compagnie",
- "Why choose Instaon",
- "Lance e obtenha mais clientes!",
- "Che cosa state aspettando?",
- "Партнёрская программа",
- "Ce que tu attends?",
- "Worauf wartest du?",
- "Você está em boas mãos",
- "Internship Social Media Expert",
- "Condizioni D'uso",
- "Money-back guarantee",
- "Harga Kontak Memulai",
- "Телефонные звонки",
- "Реклама в Facebook и Instagram",
- "Accedi Iniziare",
- "Онлайн лиды Я хочу",
- "Appels Téléphoniques",
- "Annunci Facebook e Instagram",
- "Todos os direitos reservados",
- "Все права защищены",
- "En savoir plus sur Google Ads",
- "Академия Инстаон",
- "O que você está esperando?",
- "Traffico del sito web",
- "Создать бесплатный аккаунт",
- "Alle Rechte vorbehalten",
- "Worauf wartest du"
], - "campaign": {
- "id": 762120,
- "user_id": 13,
- "platform_code": 0,
- "status": "PAUSED",
- "work_status": 1,
- "work_status_update": "2020-05-23 11:07:48",
- "draft": 0,
- "title": "Google Search - Website Traffic",
- "description": null,
- "language": 1000,
- "locations": "[{\"placeId\":\"20192\",\"type\":\"include\"}]",
- "geographical_areas": "[]",
- "destination_urls": null,
- "daily_budget": 200,
- "currency": "EUR",
- "updated_at": "2020-05-23 17:35:36",
- "created_at": "2020-05-23 11:07:48",
- "deleted_at": null,
- "phone": null,
- "goal": 0
}, - "preferences": {
- "campaign_id": 762120,
- "keyword_choices": "[\"advertising online agency\", \"agency online\", \"marketing online agency\", \"media top online agency\", \"online media agency\", \"service online agency\", \"agency web\", \"best web agency\", \"creative web agency\", \"web agency marketing\", \"web agency services\", \"web agency website\", \"web design agency\", \"web digital agency\", \"b2b internet marketing\", \"b2b marketing\", \"b2b marketing agency\", \"b2b online marketing\", \"business marketing\", \"business marketing consultant\", \"business web marketing\", \"business website marketing\", \"digital marketing business\", \"e marketing business\", \"advertising business internet marketing\", \"internet marketing business\", \"small business internet marketing\", \"local business marketing\", \"best online marketing business\", \"online marketing business\", \"creative agency\", \"creative marketing agency\", \"creative media agency\", \"a digital agency\", \"a digital marketing agency\", \"digital agency\", \"digital agency network\", \"digital agency office\", \"digital experience agency\", \"digital innovation agency\", \"digital marketing advertising agency\", \"digital marketing agency\", \"digital marketing agency new york\", \"digital marketing agency website\", \"digital marketing services agency\", \"digital marketing strategy agency\", \"digital production agency\", \"digital strategy agency\", \"from digital agency\", \"independent digital agency\", \"media digital agency\", \"new digital agency\", \"social digital agency\", \"digital company\", \"best digital marketing company\", \"best digital marketing company in world\", \"digital marketing company\", \"digital marketing company in new york\", \"digital marketing company website\", \"digital marketing strategy company\", \"leading digital marketing company\", \"online digital marketing company\", \"professional digital marketing company\", \"seo digital marketing company\", \"360 digital marketing\", \"about digital marketing course\", \"best digital marketing course\", \"big digital marketing companies\", \"cpm digital marketing\", \"creative digital marketing\", \"digital e marketing\", \"digital marketing\", \"digital marketing ads\", \"digital marketing advertising\", \"digital marketing approach\", \"digital marketing basics\", \"digital marketing blogs\", \"digital marketing branding\", \"digital marketing campaign\", \"digital marketing certificate\", \"digital marketing certificate online\", \"digital marketing certification course\", \"digital marketing chicago\", \"digital marketing classes\", \"digital marketing conference\", \"digital marketing consultant\", \"digital marketing course content\", \"digital marketing course university\", \"digital marketing curriculum\", \"digital marketing description\", \"digital marketing course details\", \"digital marketing details\", \"digital marketing development\", \"digital marketing devices\", \"digital marketing education\", \"digital marketing explanation\", \"digital marketing firms\", \"digital marketing for companies\", \"digital marketing for it companies\", \"digital marketing group\", \"digital marketing help\", \"digital marketing in\", \"top digital marketing companies in the world\", \"digital marketing includes\", \"digital marketing industry\", \"digital marketing information\", \"digital marketing it\", \"digital marketing jobs\", \"digital marketing meaning\", \"digital marketing methods\", \"digital marketing nashville\", \"digital marketing news\", \"digital marketing now\", \"digital marketing nyc\", \"digital marketing overview\", \"digital marketing players\", \"digital marketing policy\", \"digital marketing programs\", \"digital marketing providers\", \"digital marketing sales\", \"digital marketing services\", \"online digital marketing services\", \"top digital marketing services\", \"digital marketing sites\", \"digital marketing solutions\", \"digital marketing space\", \"digital marketing specialist\", \"digital marketing strategist\", \"digital marketing strategy\", \"online digital marketing strategy\", \"digital marketing subjects\", \"digital marketing techniques\", \"digital marketing technology\", \"digital marketing tools\", \"digital marketing training courses\", \"digital marketing training courses online\", \"digital marketing trends\", \"digital marketing usa\", \"digital marketing what you need to know\", \"digital marketing wiki\", \"digital marketing wikipedia\", \"digital media marketing\", \"digital media marketing course\", \"digital and social media marketing\", \"social media digital marketing\", \"digital school of marketing\", \"digital web marketing\", \"free digital marketing courses\", \"integrated digital marketing\", \"interactive digital marketing\", \"international digital marketing companies\", \"internet digital marketing\", \"le digital marketing\", \"local digital marketing\", \"local digital marketing companies\", \"digital marketing online training\", \"online digital marketing\", \"best online digital marketing courses\", \"online digital marketing courses\", \"seo digital marketing\", \"top 5 digital marketing companies\", \"top digital marketing courses\", \"top global digital marketing agencies\", \"what's digital marketing\", \"digital media strategy\", \"digital strategy\", \"account google ads\", \"google ads business account\", \"google ads free account\", \"adwords or google ads\", \"business google ads\", \"call ads on google\", \"coupon google ads\", \"google ads\", \"google ads agency\", \"google ads customer\", \"google ads keyword\", \"google ads new campaign\", \"google ads overview\", \"google ads reach\", \"google auto ads\", \"review google ads\", \"tentang google ads\", \"interactive marketing\", \"interactive marketing agency\", \"interactive marketing company\", \"interactive marketing firm\", \"local internet marketing company\", \"local marketing\", \"local marketing agency\", \"local marketing companies\", \"local online marketing\", \"online marketing for local businesses\", \"local social media marketing\", \"internet marketing advertising\", \"internet marketing online advertising\", \"marketing advertising\", \"marketing advertising agency\", \"360 marketing agency\", \"a marketing agency\", \"affiliate marketing agency\", \"brand marketing agency\", \"email marketing agency\", \"event marketing agency\", \"internet marketing agency\", \"marketing agency\", \"marketing agency ads\", \"marketing strategy agency\", \"media marketing agency\", \"social media marketing agency\", \"retail marketing agency\", \"search marketing agency\", \"sem marketing agency\", \"seo marketing agency\", \"social marketing agency\", \"technology marketing agency\", \"viral marketing agency\", \"website marketing agency\", \"companies looking for marketing agencies\", \"marketing companies\", \"marketing consultant companies\", \"online marketing campaign companies\", \"online marketing companies\", \"seo online marketing companies\", \"sports marketing companies\", \"top web marketing companies\", \"internet marketing firm\", \"marketing firm\", \"online marketing firm\", \"social media marketing firm\", \"website marketing firm\", \"best internet marketing\", \"best internet marketing company\", \"best internet marketing company in the world\", \"best internet marketing websites\", \"company internet marketing\", \"internet marketing company services\", \"corporate internet marketing\", \"free internet marketing\", \"global internet marketing\", \"internet marketing analysis\", \"internet marketing blog\", \"internet marketing campaign\", \"internet marketing coach\", \"internet marketing consultant\", \"internet marketing course\", \"internet marketing experts\", \"internet marketing help\", \"internet marketing information\", \"internet marketing methods\", \"internet marketing plan\", \"internet marketing process\", \"internet marketing promotion\", \"internet marketing resources\", \"internet marketing sales\", \"internet marketing sites\", \"internet marketing solutions\", \"internet marketing specialist\", \"internet marketing strategy\", \"internet marketing success\", \"internet marketing system\", \"internet marketing topics\", \"internet marketing training\", \"internet marketing web\", \"web internet marketing services\", \"internet marketing websites\", \"internet media marketing\", \"internet search marketing\", \"internet video marketing\", \"internet website marketing\", \"marketing by internet\", \"marketing internet\", \"marketing through internet\", \"marketing via internet\", \"marketing with internet\", \"online internet marketing\", \"seo internet marketing\", \"internet marketing consulting services\", \"services internet marketing\", \"strategic internet marketing services\", \"best online marketing company\", \"e marketing online\", \"explain online marketing\", \"it online marketing\", \"marketing online\", \"online marketing ads\", \"online marketing basics\", \"online marketing blog\", \"online marketing campaign\", \"online marketing company name\", \"online marketing consultant\", \"online marketing definition\", \"online marketing expert\", \"online marketing help\", \"online marketing information\", \"online marketing meaning\", \"online marketing of company\", \"online marketing overview\", \"online marketing seo\", \"online marketing services\", \"online marketing services company\", \"online marketing sites\", \"online marketing solutions\", \"online marketing specialist\", \"online marketing strategies\", \"online marketing techniques\", \"online marketing training courses\", \"online marketing uk\", \"online marketing websites\", \"online marketing world\", \"online sales marketing\", \"online video marketing\", \"online web marketing\", \"search online marketing\", \"the online marketing\", \"the online marketing company\", \"website online marketing\", \"what's online marketing\", \"why online marketing\", \"marketing solutions\", \"web marketing solutions\", \"marketing strategy\", \"social media marketing strategy\", \"website marketing strategy\", \"marketing training\", \"media marketing\", \"best social media marketing\", \"marketing through social media\", \"social media marketing\", \"social media marketing consultant\", \"local online advertising\", \"online advertising\", \"online digital\", \"social marketing\", \"strategy agency\", \"via web marketing\", \"web marketing\", \"web marketing campaign\", \"web marketing company\", \"web marketing consultant\", \"web marketing course\", \"web marketing information\", \"web marketing strategies\", \"web marketing tools\", \"web marketing websites\", \"website agency\", \"marketing a website\", \"website marketing\", \"website marketing company\", \"website marketing consultant\"]",
- "sentence_choices": null,
- "created_at": "2020-06-01 12:00:37",
- "updated_at": "2020-06-01 12:00:37"
}
}
}
campaignId required | string Example: {{test_campaign_id}} |
required | Array of objects (Sentence) |
{- "sentences": [
- {
- "sentence": "hello this is abc app",
- "choice": "yes"
}, - {
- "sentence": "abc app chromecast",
- "choice": "no"
}, - {
- "sentence": "appear on abc during showtimes",
- "choice": "yes"
}, - {
- "sentence": "christmas decoration tv show",
- "choice": "no"
}
]
}
campaignId required | string Example: {{test_campaign_id}} |
date_end required | integer <int32> Example: date_end=20200206 |
date_start required | integer <int32> Example: date_start=20200204 |
{- "report": {
- "impressions": 2235,
- "clicks": 242,
- "cost": 45,
- "conversions": 4,
- "click_through_rate": 20.34,
- "cost_per_click": 0.44,
- "cost_per_conversion": 604
}, - "status": "success"
}
campaignId required | string Example: {{test_campaign_id}} |
date_end required | integer <int32> Example: date_end=20200204 |
date_start required | integer <int32> Example: date_start=20200206 |
{- "report": {
- "impressions": {
- "2020-02-11": 1,
- "2020-02-12": 20,
- "2020-02-13": 73,
- "2020-02-14": 74,
- "2020-02-15": 36,
- "2020-02-16": 80,
- "2020-02-17": 36,
- "2020-02-18": 35
}, - "clicks": {
- "2020-02-11": 92,
- "2020-02-12": 9,
- "2020-02-13": 7,
- "2020-02-14": 94,
- "2020-02-15": 15,
- "2020-02-16": 23,
- "2020-02-17": 13,
- "2020-02-18": 7
}, - "cost": {
- "2020-02-11": 20,
- "2020-02-12": 53,
- "2020-02-13": 58,
- "2020-02-14": 17,
- "2020-02-15": 3,
- "2020-02-16": 51,
- "2020-02-17": 58,
- "2020-02-18": 90
}, - "conversions": {
- "2020-02-11": 41,
- "2020-02-12": 12,
- "2020-02-13": 42,
- "2020-02-14": 25,
- "2020-02-15": 51,
- "2020-02-16": 14,
- "2020-02-17": 66,
- "2020-02-18": 38
}
}, - "status": "success"
}
campaignId required | string Example: {{test_campaign_id}} |
metric required | string Example: impressions |
date_end required | integer <int32> Example: date_end=20200204 |
date_start required | integer <int32> Example: date_start=20200206 |
{- "report": {
- "male": 32,
- "female": 10,
- "other": 4,
- "unknown": 6
}, - "status": "success"
}
campaignId required | string Example: {{test_campaign_id}} |
metric required | string Example: impressions |
date_end required | integer <int32> Example: date_end=20200204 |
date_start required | integer <int32> Example: date_start=20200206 |
{- "report": {
- "desktop": 20,
- "mobile": 34,
- "tablet": 5,
- "connected_tv": 1,
- "other": 0,
- "unknown": 4
}, - "status": "success"
}
campaignId required | string Example: {{test_campaign_id}} |
metric required | string Example: impressions |
date_end required | integer <int32> Example: date_end=20200204 |
date_start required | integer <int32> Example: date_start=20200206 |
{- "report": {
- "age_range_18_24": 13,
- "age_range_25_34": 30,
- "age_range_35_44": 50,
- "age_range_45_54": 26,
- "age_range_55_64": 23,
- "age_range_65_up": 62,
- "unknown": 34
}, - "status": "success"
}
Suggestions are actions that are recommended to a given user in order to improve marketing results.