Models - wowanalytics/Api-Samples GitHub Wiki
#User
{
"name": "Gary Johns",
"emailAddress": "[email protected]"
}
name the user name
emailAddress the users email address
#Company
{
"name": "Communigator Limited",
"domain": "communigator.co.uk",
"street": "The Old Byre, Peper Harow",
"city": "Godalming",
"county": "Surrey",
"postCode": "GU2 8PR",
"country": "United Kingdom",
"region": "South East",
"employees": "20 - 50",
"industries": [
{
"name": "Advertising & Marketing",
"level1": "Bizservice",
"level2": "Marketing",
"level3": null
},
{
"name": "Business Services",
"level1": "Bizservice",
"level2": null,
"level3": null
},
{
"name": "Custom Software & Technical Consulting",
"level1": "Software",
"level2": "Consulting",
"level3": null
},
{
"name": "Software",
"level1": "Software",
"level2": null,
"level3": null
}
],
"phoneNumber": "+44 1483 698270",
"companyDescription": "CommuniGator Ltd has a characteristically fresh approach; treat email marketing with the attention it deserves, and your audience will do the same. The features and functions of CommuniGator's digital marketing software (GatorMail) have been developed to make the marketers job easier and more effective. We work very closely with the Institute of Direct Marketing and the Direct Marketing Association to ensure our methods and practices are in line with best practice. Established in 2005, CommuniGator has rapidly become one of the leading email marketing software providers in the UK. Hundreds of companies rely on CommuniGator for on-demand, on-premise or fully managed email marketing solutions, including companies such as British Sugar, Visit Britain, Aspire Technology, La Manga Rentals and Jordans. \n\nWe will take into account your budget, listen to your objectives and requirements and advise on the right solution to deliver exactly what you need. Call us now on 01483 698270 to unleash the potential of email marketing for your business. ",
"revenue": "$1M to $5M"
}
name the name of the company
domain the company domain if known
street the street the company is on
city the city the company is in
county the companies county
postCode the company postcode
country the company country
region the region if known
employees the band of employees
industries array or Industry that the company is in
phoneNumber company telephone number is known
companyDescription the company description
revenue the revenue band of the company
#Industry
{
"name": "Advertising & Marketing",
"level1": "Bizservice",
"level2": "Marketing",
"level3": null
}
#Lead
{
"id": "00000000-0000-0000-0000-000000000000",
"totalScore": 20,
"type": "Lead",
"status": "Open",
"companyName": "Communigator Limited",
"permaLink": "https://app.wowanalytics.co.uk/Permalink/Company/00000000-0000-0000-0000-000000000000",
"assignedTo": [
{
"name": "A Sales",
"emailAddress": "[email protected]"
}
],
"emailAddress": "[email protected]",
"clientId": "00000000-0000-0000-0000-000000000000",
"lastVisit": "2015-02-12T10:18:22",
"leadBand": "Hot",
"assignedDate": "2014-03-05T14:07:45",
"firstVisit": "2014-11-12T15:17:09",
"company": {
"name": "Communigator Limited",
"domain": "communigator.co.uk",
"street": "The Old Byre, Peper Harow",
"city": "Godalming",
"county": "Surrey",
"postCode": "GU2 8PR",
"country": "United Kingdom",
"region": "South East",
"employees": "20 - 50",
"industries": [
{
"name": "Advertising & Marketing",
"level1": "Bizservice",
"level2": "Marketing",
"level3": null
},
{
"name": "Business Services",
"level1": "Bizservice",
"level2": null,
"level3": null
},
{
"name": "Custom Software & Technical Consulting",
"level1": "Software",
"level2": "Consulting",
"level3": null
},
{
"name": "Software",
"level1": "Software",
"level2": null,
"level3": null
}
],
"phoneNumber": "+44 1483 698270",
"companyDescription": "CommuniGator Ltd has a characteristically fresh approach; treat email marketing with the attention it deserves, and your audience will do the same. The features and functions of CommuniGator's digital marketing software (GatorMail) have been developed to make the marketers job easier and more effective. We work very closely with the Institute of Direct Marketing and the Direct Marketing Association to ensure our methods and practices are in line with best practice. Established in 2005, CommuniGator has rapidly become one of the leading email marketing software providers in the UK. Hundreds of companies rely on CommuniGator for on-demand, on-premise or fully managed email marketing solutions, including companies such as British Sugar, Visit Britain, Aspire Technology, La Manga Rentals and Jordans. \n\nWe will take into account your budget, listen to your objectives and requirements and advise on the right solution to deliver exactly what you need. Call us now on 01483 698270 to unleash the potential of email marketing for your business. ",
"revenue": "$1M to $5M"
}
}
id the id of the lead
totalScore the total score of the lead
type the type of lead
status the lead status
companyName the name of the company (will be "No Company" if the lead is a contact and is not associated with a company)
permaLink the URL to the view the permalink for the lead
assignedTo array of User that the lead is assigned to
emailAddress the last email address picked up for the company
clientId the client id that the lead belongs to (will be the same as the client id passed in)
lastVisit the date and time of the last recorded visit
leadBand the lead band the lead is in based on the total score
assignedDate the date and time that the lead was last assigned
firstVisit the date and time of the leads first visit. For older leads this could be null
company the Company that the lead is for Note this can be null
#Tracked Link
{
"linkId": "00000000-0000-0000-0000-000000000000",
"title": "Home",
"url": "http://domain.com/homepage",
"categories": [],
"visited": "2015-02-12T14:32:13",
"pageType": "Page",
"leadId": "00000000-0000-0000-0000-000000000000",
"refererUrl": "",
"webBrowser": "IE 11.0 ",
"campaign": "The Camapign",
"pageScore": 1,
"source": "GatorMail",
"medium": "Email",
"term": "Accessed",
"contactId": "00000000-0000-0000-0000-000000000000",
"crmPersonId": "xxxx",
"crmType": "CONTACT",
"crmAccountId": "",
"emailAddress": "[email protected]"
"personId": 0,
"custom1": "sample string 17",
"custom2": "sample string 18",
"custom3": "sample string 19"
}
linkId unique id for the link
title the title of the page viewed
url the url of the page viewed
categories array of strings, containing the categories that the page is in
visited the date time of when the page was viewed
pageType the type of page viewed
leadId the id of the lead that viewed the page
refererUrl the referrer Url
webBrowser the web browser used to view the page
campaign the campaign, this could be the utm_campaign value or the Communigator camapaign
pageScore the score of the page when viewed
source the utm_source
medium the utm_medium
term the utm_term
contactId the id of the contact lead that viewed the page
crmPersonId if the link is from a Communigator campaign this is the CRM id provided
crmType this is the CRM type provided by Communigator
crmAccountId this is the CRM account Id provided by Communigator
emailAddress if the email address of the contact viewing the page
personId is the id of the contact in Communigator
custom1 is the custom 1 value sent using the tracking script
custom2 is the custom 2 value sent using the tracking script
custom3 is the custom 3 value sent using the tracking script