Leads - wowanalytics/Api-Samples GitHub Wiki
#Leads Lead information is obtained by the following methods
####/client/{clientId}/leads/types Method: GET
returns types of lead in the system with a count of how many there are of that type
[
{
"type": "Contact",
"leads": 287
},
{
"type": "Customer",
"leads": 84
},
{
"type": "Lead",
"leads": 1792
},
{
"type": "Partner",
"leads": 1
},
{
"type": "Qualified",
"leads": 13
},
{
"type": "Self",
"leads": 1
},
{
"type": "Supplier",
"leads": 2
}
]
Where
type the type of lead
leads the number of leads of this type
####/client/{clientId}/latestleads/{minutes}/{numberToGet} Method: GET
This method gets the latest leads within the supplied number of miniutes. The Max allowed number of minutes is 60. You will get a 404 response for anything above this
{minutes} the last number of minutes to get the data for (Max 60)
{numberToGet} the number of leads to get
Returns an array of Leads
[
{
"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": "00000000-0000-0000-0000-000000000000",
"totalScore": 100,
"type": "Lead",
"status": "Open",
"companyName": "A Company",
"permaLink": "https://app.wowanalytics.co.uk/Permalink/Company/00000000-0000-0000-0000-000000000000",
"assignedTo": [],
"emailAddress": "",
"clientId": "00000000-0000-0000-0000-000000000000",
"lastVisit": "2015-02-12T10:11:17",
"leadBand": "Hot",
"assignedDate": null,
"firstVisit": "2014-11-12T15:13:25",
"company": null
},...
]
####/client/{clientId}/leads/{type}/{startDate}/{endDate}/{page}/{take} Method: GET
This method gets the leads from the specified date range, for the requested lead type
{type} the type of lead to return
{startDate} the date to get the leads from (in the format yyyy-mm-dd)
{endDate} the date to get the leads too (in the format of yyyy-mm-dd)
{page} the page to get
{take} the number of leads to get per page
Returns an paged array of Leads
{
"data": [
"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"
},.....
],
"pageCount": 1,
"totalItemCount": 20,
"pageIndex": 0,
"pageNumber": 1,
"pageSize": 100,
"hasPreviousPage": false,
"hasNextPage": false,
"isFirstPage": true,
"isLastPage": true,
"firstItemOnPage": 1,
"lastItemOnPage": 20
}
Where
data an array of Leads
pageCount the number of pages available
totalItemCount the total number of leads found
pageIndex the index of the current page (zero based)
pageNumber the number of the current page
pageSize how many leads are contained on the current page
hadPreviousPage is a previous page available
hasNextPage is there another page to request
isFirstPage is this the first page in the available results
isLastPage is this the past page in the available results
firstItemOnPage the index of the first item on the page in relation to the complete resultset (one based)
lastItemOnPage the index of the last item on the page in relation to the complete resultset (one based)
####/client/{clientId}/leads/{type}/search/{startDate}/{endDate}/{page}/{take} Method: POST
This method gets the leads from the specified date range, for the requested lead type
{type} the type of lead to return
{startDate} the date to get the leads from (in the format yyyy-mm-dd)
{endDate} the date to get the leads too (in the format of yyyy-mm-dd)
{page} the page to get
{take} the number of leads to get per page
Post values
{
"searchType": "Page",
"search": "home",
"utm": {
"utmName": "",
"utmMedium": "",
"utmSource": "",
"utmTerm": "",
"utmContent": ""
}
"matchType": "Anywhere",
}
searchType: is one of the following values
Page : search value in the url domain is ignored
Keyword : search for a keyword
PPC : search for PPC keyword
search : text to search for
utm
utmName : the utm_campaign value to search for
utmMedium: the utm_medium value to search for
utmSource : the utm_source value to search for
utmTerm : the utm_term value to search for
utmContent : the utm_content value to search for
matchType : is
Exact : search for an exact match
Anywhere : search for the chosen value anywhere
Start : search for the chosen value at the start
End : search for the chosen value at the end
Returns an paged array of Leads
{
"data": [
"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"
},.....
],
"pageCount": 1,
"totalItemCount": 20,
"pageIndex": 0,
"pageNumber": 1,
"pageSize": 100,
"hasPreviousPage": false,
"hasNextPage": false,
"isFirstPage": true,
"isLastPage": true,
"firstItemOnPage": 1,
"lastItemOnPage": 20
}
Where
data an array of Leads
pageCount the number of pages available
totalItemCount the total number of leads found
pageIndex the index of the current page (zero based)
pageNumber the number of the current page
pageSize how many leads are contained on the current page
hadPreviousPage is a previous page available
hasNextPage is there another page to request
isFirstPage is this the first page in the available results
isLastPage is this the past page in the available results
firstItemOnPage the index of the first item on the page in relation to the complete resultset (one based)
lastItemOnPage the index of the last item on the page in relation to the complete resultset (one based)
####/client/{clientId}/leads/search/{types}/{page}/{take}?startDate={startDate}&endDate={endDate} Method: POST
This method gets the leads from the specified date range, for the requested lead type
{type} a comma separated list of lead types to return
{page} the page to get
{take} the number of leads to get per page
{startDate} the date and time to get the leads from (in the format yyyy-mm-ddTHH:mm)
{endDate} the date and time to get the leads too (in the format of yyyy-mm-ddTHH:mm)
NOTE:
- The max search time is the last 7 days.
- When searching for a URL the domain part will be ignored.
Post values
{
"searchType": "Page",
"search": "home",
"utm": {
"utmName": "",
"utmMedium": "",
"utmSource": "",
"utmTerm": "",
"utmContent": ""
}
"matchType": "Anywhere",
}
searchType: is one of the following values
Page : search value in the url domain is ignored
Keyword : search for a keyword
PPC : search for PPC keyword
search : text to search for
utm
utmName : the utm_campaign value to search for
utmMedium: the utm_medium value to search for
utmSource : the utm_source value to search for
utmTerm : the utm_term value to search for
utmContent : the utm_content value to search for
matchType : is
Exact : search for an exact match
Anywhere : search for the chosen value anywhere
Start : search for the chosen value at the start
End : search for the chosen value at the end
Returns an paged array of Leads
{
"data": [
"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"
},.....
],
"pageCount": 1,
"totalItemCount": 20,
"pageIndex": 0,
"pageNumber": 1,
"pageSize": 100,
"hasPreviousPage": false,
"hasNextPage": false,
"isFirstPage": true,
"isLastPage": true,
"firstItemOnPage": 1,
"lastItemOnPage": 20
}
Where
data an array of Leads
pageCount the number of pages available
totalItemCount the total number of leads found
pageIndex the index of the current page (zero based)
pageNumber the number of the current page
pageSize how many leads are contained on the current page
hadPreviousPage is a previous page available
hasNextPage is there another page to request
isFirstPage is this the first page in the available results
isLastPage is this the past page in the available results
firstItemOnPage the index of the first item on the page in relation to the complete resultset (one based)
lastItemOnPage the index of the last item on the page in relation to the complete resultset (one based)
####/client/{clientId}/lead/{leadId} Method: GET
returns the requested lead id
{
"id": "00000000-0000-0000-0000-000000000000",
"totalScore": 234,
"type": "Lead",
"status": "Open",
"companyName": "Communigator Limited",
"permaLink": "https://app.wowanalytics.co.uk/Permalink/Company/da0b430e-089b-415f-9805-86b351c794ec",
"assignedTo": [],
"emailAddress": "[email protected]",
"clientId": "00000000-0000-0000-0000-000000000000",
"lastVisit": "2015-02-12T13:25:05",
"leadBand": "Hot",
"assignedDate": null,
"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"
}
}
Returns a Lead