Difference between revisions of "Reports"
From Advice Local Wiki
(→Insight Data) |
(→Insight Data) |
||
| Line 859: | Line 859: | ||
== Insight Data == | == Insight Data == | ||
| − | This endpoint provides historical data for insights provided by Google My Business if enabled and activated. Dates can be filtered using where clauses in the as a JSON parameter like where={ recordedAt: { ">": "2020-03-01" } } | + | This endpoint provides historical data for insights provided by Google My Business if enabled and activated. Dates can be filtered using where clauses in the as a JSON parameter like where={ recordedAt: { ">": "2020-03-01" } }. The same type of logic can be applied to multiple data points. When calling for multiple data points, it is important to included the ?limit and ?skip parameters to properly pagination results to improve performance. Insight data requires the partner key of the corresponding client/location. |
| + | |||
=== API Endpoint === | === API Endpoint === | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
Revision as of 10:11, 13 May 2020
Contents
Trigger a Report
This endpoint will generate a Baseline Report.
API Endpoint
http://p.lssdev.com/legacyclients/{client_id}/refresh
Example Request
GET /legacyclients/3201926/refresh HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
Example Response
{
"status": 200,
"success": true,
"error": null,
"data": "report initiated"
}
Directory Data Report
This endpoint returned directories report. This endpoint will keep a history of all reports per directory and may returned one to many results.
API Endpoint
http://p.lssdev.com/legacydirectorydata?client={client_id}
Example Request
GET /legacydirectorydata?client=3201926 HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
Example Response
{
"status": 200,
"success": true,
"error": null,
"data": [
{
"client": 3201926,
"partner": 7,
"data": {
"dirName": "Chamberofcommerce",
"dirHandle": "chamberofcommerce",
"dirQuery": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
"results": 4,
"result": [
{
"link": "https://www.chamberofcommerce.com/newport-beach-ca/25230470-ginas-pizza",
"methods": {
"url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
"enclosure": "main-content",
"enctype": "class"
},
"title": "Gina's Pizza",
"tech": "false",
"nap": {
"nap": {
"name": "Gina's Pizza",
"address": "3142 W Balboa Blvd - Newport Beach, California 92663",
"phone": "(949) 723-4462",
"n": {
"percentage": 100
},
"a": {
"percentage": 100
},
"p": {
"percentage": 100
}
},
"score": 100
},
"fulfillment": false
},
{
"link": "https://www.chamberofcommerce.com/newport-beach-ca/32128621-ginas-pizza",
"methods": {
"url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
"enclosure": "main-content",
"enctype": "class"
},
"title": "Ginas Pizza Inc",
"tech": "false",
"nap": {
"nap": {
"name": "Ginas Pizza Inc",
"address": "309 Palm St - Newport Beach, California 92661",
"phone": "(949) 673-8516",
"n": {
"percentage": 100
},
"a": {
"percentage": 77
},
"p": {
"percentage": 60
}
},
"score": 79
},
"fulfillment": false
},
{
"link": "https://www.chamberofcommerce.com/newport-beach-ca/44339193-ginas-pizza-newport",
"methods": {
"url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
"enclosure": "main-content",
"enctype": "class"
},
"title": "Ginas Pizza Newport",
"tech": "false",
"nap": {
"nap": {
"name": "Ginas Pizza Newport",
"address": "4507 W Coast Hwy - Newport Beach, California 92663",
"phone": "(949) 722-1236",
"n": {
"percentage": 74
},
"a": {
"percentage": 80
},
"p": {
"percentage": 70
}
},
"score": 75
},
"fulfillment": false
},
{
"link": "https://www.chamberofcommerce.com/newport-beach-ca/34418872-ginas-pizza-inc",
"methods": {
"url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
"enclosure": "main-content",
"enctype": "class"
},
"title": "Gina's Pizza Inc",
"tech": "false",
"nap": {
"nap": {
"name": "Gina's Pizza Inc",
"address": "Po Box 11269 - Newport Beach, California 92658",
"phone": "(949) 760-0848",
"n": {
"percentage": 100
},
"a": {
"percentage": 68
},
"p": {
"percentage": 50
}
},
"score": 73
},
"fulfillment": false
}
]
},
"results": "true",
"errors": "false",
"score": 100,
"id": 52444619,
"batch": "320192620171213",
"createdAt": "2017-12-13T22:07:55.000Z",
"directory": "chamberofcommerce",
"elapsedTime": 1148
},
{
"client": 3201926,
"partner": 7,
"data": {
"dirName": "2findlocal",
"dirHandle": "2findlocal",
"dirQuery": "http://www.2findlocal.com/search?k=gina+pizza&w=newport+beach%2C+ca",
"results": 0
},
"results": "false",
"errors": "false",
"score": 0,
"id": 52444620,
"batch": "320192620171213",
"createdAt": "2017-12-13T22:07:56.000Z",
"directory": "2findlocal",
"elapsedTime": 1606
},
{
"client": 3201926,
"partner": 7,
"data": {
"dirName": "Angieslist",
"dirHandle": "angieslist",
"dirQuery": "https://www.google.com/search?q=site%3Aangieslist.com%2Fcompanylist%2F+Gina%27s+Pizza+Newport+Beach%2C+CA&ie=utf-8&hl=en&as_qdr=all&aq=t&rls=org:mozilla:us:official&client=firefox&num=2&filter=1&nojs=1",
"results": 0
},
"results": "false",
"errors": "false",
"score": 0,
"id": 52444621,
"batch": "320192620171213",
"createdAt": "2017-12-13T22:07:56.000Z",
"directory": "angieslist",
"elapsedTime": 2089
},
{...},
{...}
],
"total": 39
}
Additional Directory Data Report
This endpoint returned a curated list of directories report. This endpoint returned a single result per directory.
API Endpoint
https://praxis.lssdev.com/api/v2/report/get-directory-nap/{client_id}
Example Request
GET /api/v2/report/get-directory-nap/3201926 HTTP/1.1
Host: praxis.lssdev.com
x-api-token: YOUR_API_KEY
Example Response
{
"foursquare": {
"napData": {
"name": "Cameron Creek",
"street": "1900 Cardinal Trail Drive",
"suite": "",
"city": "Galloway",
"state": "OH",
"zipcode": "43119",
"country": "US",
"phone": "8552517207",
"website": "http://www.cameroncreekapts.com/"
},
"scraperData": {
"dirHandle": "foursquare",
"dirName": "Foursquare",
"dirQuery": "https://foursquare.com/explore?mode=url&near=galloway%2c+oh+43119&q=Cameron+Creek",
"dups": [
{
"fulfillment": false,
"link": "http://www.foursquare.com/v/cameron-creek/55f32629498e537abeb110b6",
"methods": {
"addr_enc": "class",
"addr_kind": "class",
"addr_sym": "primaryInfo",
"addr_tag": "div",
"addr_val": "adr",
"enclosure": "resultsView",
"enctype": "id",
"phone_enc": "class",
"phone_kind": "class",
"phone_sym": "linkAttrValue",
"phone_tag": "span",
"phone_val": "tel",
"size": 10000,
"url": "https://foursquare.com/explore?mode=url&near=galloway%2c+oh+43119&q=Cameron+Creek"
},
"nap": {
"nap": {
"a": {
"percentage": 100
},
"address": "1900 Cardinal Trail Dr Galloway, OH 43119 United States",
"n": {
"percentage": 100
},
"name": "Cameron Creek",
"p": {
"percentage": 100
},
"phone": "(855) 251-7207"
},
"score": 100
},
"tech": "false",
"title": "Cameron Creek"
}
],
"result": [
{
"fulfillment": true,
"link": "https://foursquare.com/v/cameron-creek/59f25e751acf117283fc0b35",
"methods": {
"addr_enc": "class",
"addr_kind": "class",
"addr_sym": "primaryInfo",
"addr_tag": "div",
"addr_val": "adr",
"enclosure": "resultsView",
"enctype": "id",
"phone_enc": "class",
"phone_kind": "class",
"phone_sym": "linkAttrValue",
"phone_tag": "span",
"phone_val": "tel",
"size": 10000,
"url": "https://foursquare.com/explore?mode=url&near=galloway%2c+oh+43119&q=Cameron+Creek"
},
"nap": {
"nap": {
"a": {
"percentage": 100
},
"address": "1900 Cardinal Trail Dr Galloway, OH 43119 United States",
"n": {
"percentage": 100
},
"name": "Cameron Creek",
"p": {
"percentage": 100
},
"phone": "(855) 251-7207"
},
"score": 100
},
"tech": "false",
"title": "Cameron Creek"
}
],
"results": 2
},
"message": "Data sent to source, scraper data could be older",
"scraperLink": "https://foursquare.com/v/cameron-creek/59f25e751acf117283fc0b35",
"apiLink": "https://foursquare.com/v/cameron-creek/59f25e751acf117283fc0b35"
},
"localstack": {
"napData": {
"name": "Cameron Creek",
"street": "1900 Cardinal Trail Drive",
"suite": "",
"city": "Galloway",
"state": "OH",
"zipcode": "43119",
"country": "US",
"phone": "8552517207",
"website": "http://www.cameroncreekapts.com/"
},
"scraperData": {
"dirHandle": "localstack",
"dirName": "Localstack",
"dirQuery": "http://www.localstack.com",
"noDataAvailable": true,
"result": [
{
"link": "https://localstack.com/biz/cameron-creek-milwaukee-wi/3011584",
"nap": {
"nap": {
"a": {
"percentage": 100
},
"address": "1900 Cardinal Trail Drive Galloway OH 43119",
"n": {
"percentage": 100
},
"name": "Cameron Creek",
"p": {
"percentage": 100
},
"phone": "8552517207"
},
"score": 100
}
}
],
"results": 1
},
"message": "Data sent to source, scraper data could be older",
"scraperLink": "https://localstack.com/biz/cameron-creek-milwaukee-wi/3011584",
"apiLink": "https://localstack.com/biz/cameron-creek-milwaukee-wi/3011584"
},
"bubblelife": {
"napData": {
"name": "Cameron Creek",
"street": "1900 Cardinal Trail Drive",
"suite": "",
"city": "Galloway",
"state": "OH",
"zipcode": "43119",
"country": "US",
"phone": "8552517207",
"website": "http://www.cameroncreekapts.com/"
},
"scraperData": {
"dirHandle": "bubblelife",
"dirName": "Bubblelife",
"dirQuery": "#",
"result": [
{
"fulfillment": false,
"link": "http://directory.bubblelife.com/listing/35677601/Cameron_Creek",
"methods": {
"enclosure": "",
"enctype": "",
"noproxy": true,
"url": "#"
},
"nap": {
"nap": {
"a": {
"percentage": 100
},
"address": "1900 Cardinal Trail Drive, Galloway, OH, 43119",
"n": {
"percentage": 100
},
"name": "Cameron Creek",
"p": {
"percentage": 100
},
"phone": "8552517207"
},
"score": 100
},
"tech": "false",
"title": "Cameron Creek"
}
],
"results": 1
},
"message": "Data sent to source, scraper data could be older",
"scraperLink": "http://directory.bubblelife.com/listing/35677601/Cameron_Creek",
"apiLink": "http://directory.bubblelife.com/listing/35677601/Cameron_Creek"
},
{...},
{...}
}
Local Data Report
API Endpoint
http://p.lssdev.com/legacylocaldata?client={client_id}
Example Request
GET /legacylocaldata?client=3201926 HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
Example Response
{
"status": 200,
"success": true,
"error": null,
"data": [
{
"client": 3201926,
"partner": 7,
"link": "http://www.yelp.com/biz/ginas-pizza-newport-beach-2?osq=Gina%27s+Pizza",
"claimed": "null",
"hours": "true",
"description": "null",
"categories": 3,
"photos": 0,
"website": "http://ginaspizza.com",
"n": "Gina?s Pizza",
"a": "3142 W Balboa Blvd Newport Beach, CA 92663",
"p": "(949) 723-4462",
"id": 6945921,
"createdAt": "2017-12-13T22:08:39.000Z",
"directory": "yelp",
"batch": "3201926-2017-12-13 22:08:39",
"nScore": 100,
"aScore": 100,
"pScore": 100,
"napScore": 100,
"data": {
"n": "Gina?s Pizza",
"link": "http://www.yelp.com/biz/ginas-pizza-newport-beach-2?osq=Gina%27s+Pizza",
"a": "3142 W Balboa Blvd Newport Beach, CA 92663",
"p": "(949) 723-4462",
"local": {
"website": "ginaspizza.com",
"categories": [
"pizza",
"italian",
"sandwiches"
],
"opening_hours": [
{
"day": "Mon",
"open": "11:00 am",
"close": "9:30 pm"
},
{
"day": "Tue",
"open": "11:00 am",
"close": "9:30 pm"
},
{
"day": "Wed",
"open": "11:00 am",
"close": "9:30 pm"
},
{
"day": "Thu",
"open": "11:00 am",
"close": "9:30 pm"
},
{
"day": "Fri",
"open": "11:00 am",
"close": "10:30 pm"
},
{
"day": "Sat",
"open": "11:00 am",
"close": "10:30 pm"
},
{
"day": "Sun",
"open": "11:00 am",
"close": "9:30 pm"
}
],
"rating": "3.0",
"reviews": 194
},
"reputation": {
"rating": "3.0",
"reviews": 194,
"contents": [
{
"author": "Nijole T.",
"avatar": "",
"rated": "4.0",
"review": "Delicious pizza at Gina's!\nWe all enjoyed the crust and ample toppings, everything is always fresh an made to order.\nAn XL fed our family of 4 with plenty of leftovers, making it a great deal for just under $30.\nService is nice, pizzas ready in about 15 minutes.\nGreat place for a casual lunch or dinner.",
"date": "2017-07-25 00:00:00"
},
{
"author": "Michael F.",
"avatar": "",
"rated": "2.0",
"review": "Had small pizza, kids pizza, bruschetta and tomato canters salad. NOT WORTH $50!!!\n\nPizza was just ok. Salad was all spring mix. All food Not much flavor and over priced. \n\nDisappointed",
"date": "2017-10-26 00:00:00"
},
{...},
{...}
]
}
}
},
{
"client": 3201926,
"partner": 7,
"link": "https://www.google.com/maps?cid=15412785221185897851",
"claimed": "true",
"hours": "true",
"description": "null",
"categories": 7,
"photos": 1,
"website": "http://www.ginaspizza.com/",
"n": "Gina's Pizza",
"a": "3142 W Balboa Blvd, Newport Beach, CA 92663",
"p": "(949) 723-4462",
"id": 6945922,
"createdAt": "2017-12-13T22:08:39.000Z",
"directory": "google",
"batch": "3201926-2017-12-13 22:08:39",
"nScore": 100,
"aScore": 100,
"pScore": 100,
"napScore": 100,
"data": {
"cid": "15412785221185897851",
"description": "",
"name": "Gina's Pizza",
"place_url": "https://www.google.com/maps?cid=15412785221185897851",
"categories": [
"pizza restaurant",
"deliveries",
"fast food container",
"italian restaurant",
"pizza delivery",
"pizza",
"western food"
],
"gcid": [
"gcid:pizza_restaurant",
"gcid:italian_restaurant",
"gcid:pizza_delivery_service"
],
"keywords": [
"deliveries",
"fast food container",
"pizza",
"western food"
],
"photos": 0,
"claimed": "yes",
"reviews": 84,
"rating": "4.4",
"address": "3142 W Balboa Blvd, Newport Beach, CA 92663",
"area_code": "949",
"business_phone": "(949) 723-4462",
"website": {
"link": "http://www.ginaspizza.com/",
"domain": "ginaspizza.com"
},
"opening_hours": {
"1": {
"day": "Monday",
"hours": "11AM–10PM"
},
"2": {
"day": "Tuesday",
"hours": "11AM–10PM"
},
"3": {
"day": "Wednesday",
"hours": "11AM–10PM"
},
"4": {
"day": "Thursday",
"hours": "11AM–10PM"
},
"5": {
"day": "Friday",
"hours": "11AM–11PM"
},
"6": {
"day": "Saturday",
"hours": "11AM–11PM"
},
"7": {
"day": "Sunday",
"hours": "11AM–10PM"
}
},
"place_id": null,
"is_places": "no",
"nap": {
"n": 100,
"a": 100,
"p": 100,
"t": 100
}
}
},
{
"client": 3201926,
"partner": 7,
"link": "",
"claimed": "",
"hours": "false",
"description": "null",
"categories": 0,
"photos": 0,
"website": "",
"n": "",
"a": "",
"p": "",
"id": 6945923,
"createdAt": "2017-12-13T22:08:39.000Z",
"directory": "yahoo",
"batch": "3201926-2017-12-13 22:08:39",
"nScore": 0,
"aScore": 0,
"pScore": 0,
"napScore": 0,
"data": null
},
{
"client": 3201926,
"partner": 7,
"link": "http://www.bing.com/local?lid=YN873x105183062",
"claimed": "null",
"hours": "null",
"description": "null",
"categories": 0,
"photos": 6,
"website": "http://ginaspizza.com/",
"n": "Gina's Pizza",
"a": "3142 W Balboa Blvd, Newport Beach, CA 92663",
"p": "(949) 723-4462",
"id": 6945924,
"createdAt": "2017-12-13T22:08:39.000Z",
"directory": "bing",
"batch": "3201926-2017-12-13 22:08:39",
"nScore": 100,
"aScore": 100,
"pScore": 100,
"napScore": 100,
"data": {
"data": {
"present": 1,
"photos": 6,
"website": "http://ginaspizza.com/",
"reviews": 0,
"bingpage": "http://www.bing.com/local?lid=YN873x105183062",
"napscore": {
"nap": {
"n": 100,
"a": 100,
"p": 100
},
"score": 100
},
"score": 100
},
"nap": [
"Gina's Pizza",
"3142 W Balboa Blvd, Newport Beach, CA 92663",
"(949) 723-4462",
"(949) 723-4462",
"(949) 723-4462",
"http://www.bing.com/local?lid=YN873x105183062"
]
}
}
],
"total": 4
}
General Rollup Report
This endpoint returned client rollup report averages, sum totals, and count.
API Endpoint
https://praxis.lssdev.com/api/v2/partner/{partner_id}/rollup/get-scores/
Example Request
GET /api/v2/partner/{partner_id}/rollup/get-scores/ HTTP/1.1
Host: praxis.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
Example Response
{
"avgs": {
"baseline_accurate": 5,
"baseline_acuracy": 92,
"baseline_directory": 20,
"baseline_inaccurate": 30,
"baseline_local": 41,
"baseline_monitored": 35,
"baseline_nap": 28,
"baseline_presence": 14,
"baseline_present": 5,
"baseline_visibility": 28,
"monthly_accuracy": 92,
"monthly_accurate": 38,
"monthly_bing": 59,
"monthly_google": 49,
"monthly_inaccurate": 3,
"monthly_local": 49,
"monthly_monitored": 42,
"monthly_nap": 81,
"monthly_presence": 95,
"monthly_present": 40,
"monthly_visivility": 81,
"monthly_yelp": 40,
"montlhy_directory": 98
},
"count": 211,
"totals": {
"baseline_accurate": 1004,
"baseline_acuracy": 19349,
"baseline_directory": 4232,
"baseline_inaccurate": 6325,
"baseline_local": 8744,
"baseline_monitored": 7329,
"baseline_nap": 5813,
"baseline_presence": 3049,
"baseline_present": 1140,
"baseline_visibility": 5809,
"monthly_accuracy": 19349,
"monthly_accurate": 8113,
"monthly_bing": 12349,
"monthly_google": 10408,
"monthly_inaccurate": 693,
"monthly_local": 10414,
"monthly_monitored": 8806,
"monthly_nap": 17072,
"monthly_presence": 20059,
"monthly_present": 8404,
"monthly_visivility": 17068,
"monthly_yelp": 8494,
"montlhy_directory": 20692
}
}
Overview scores data
This endpoint will returned the report overview scores for a given client. This overview will include voice scoring details and general score as well.
API Endpoint
https://p.lssdev.com/api/v2/report/get-overview/{clientid}
Example Request
GET /api/v2/report/get-overview/{clientid} HTTP/1.1
Host: praxis.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
Example Response
{
"baselineOverview": {
"bingScore": 99,
"directoriesScore": 34,
"gmbScore": 100,
"visibilityScore": 55,
"yelpScore": 83,
"voiceData": {
"alexa": "Ready, but has wrong information",
"bixby": "Ready",
"cortana": "Ready",
"googleAsistant": "Ready",
"siri": "Ready",
"voiceSearchReadines": 95
}
},
"monthlyOverview": {
"bingScore": 100,
"directoriesScore": 100,
"gmbScore": 95,
"visibilityScore": 97,
"yelpScore": 78,
"voiceData": {
"alexa": "Ready, but has wrong information",
"bixby": "Ready",
"cortana": "Ready",
"googleAsistant": "Ready, but has wrong information",
"siri": "Ready",
"voiceSearchReadines": 90
}
}
}
Insight Data
This endpoint provides historical data for insights provided by Google My Business if enabled and activated. Dates can be filtered using where clauses in the as a JSON parameter like where={ recordedAt: { ">": "2020-03-01" } }. The same type of logic can be applied to multiple data points. When calling for multiple data points, it is important to included the ?limit and ?skip parameters to properly pagination results to improve performance. Insight data requires the partner key of the corresponding client/location.
API Endpoint
https://p.lssdev.com/legacyinsightdata?client={clientid}
Example Request
GET /api/v2/report/get-overview/{clientid} HTTP/1.1
Host: praxis.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
Example Response
{
"status": 200,
"success": true,
"error": null,
"data": [
{
"id": 123,
"updatedAt": "2020-01-01 00:00:00",
"createdAt": "2020-01-01 00:00:00",
"recordedAt": "2020-01-01 00:00:00",
"client": 123,
"la_score": 100,
"brand_score": 87,
"influence_score": 77,
"reputation_score": 78,
"engagement_score": 97,
"website_visits": 4423,
"phone_calls_clicks": 143,
"phone_calls_tracked": 12,
"directions": 5,
"posts_clicks": 1566,
"calls_directions": 545,
"conv_rate": 77.5,
"total_conversions": 64,
"avg_sale_price": 12.57,
"potential_revenue": 6600,
"investment": 200,
"potential_roi": 7800,
"review_rating": 4,
"photo_views": 487,
"discovery_impressions": 123,
"listing_view": 66,
"total_calls": 154,
"first_time_caller": 23,
"duration": "1:48",
"daily_cost": 66.45,
"active_locations": 344,
"cost_per_location": 2.45,
"total_impressions": 8794,
"cpm": 3.55,
"total_actions": 554,
"cost_per_action": 354,
"total_contacts": 17,
"cost_per_contact": 12.5,
}
]
}
