Difference between revisions of "Reports"

From Advice Local Wiki
Jump to: navigation, search
(→‎Example Request)
(→‎Example Request)
 
(60 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
== Trigger a Report ==
+
== Get Client Report ==
−
This endpoint will generate a Baseline Report.
+
This endpoint will return a large object that contains data.overview and data.data properties.  Within each of those properties is baseline data, and optionally monthly progress data if the location is active with products and services.  The overview section corresponds to the scores that can be seen on the baseline report within the dashboards.  The data.data property has the individual scores and flags for each directory and local scan.
 +
 
 
=== API Endpoint ===
 
=== API Endpoint ===
 
<syntaxhighlight lang="html">
 
<syntaxhighlight lang="html">
−
http://p.lssdev.com/legacyclients/{client_id}/refresh
+
http://p.lssdev.com/legacyclients/{client_id}/report
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== Example Request ===
 
=== Example Request ===
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
−
GET /legacyclients/3201926/refresh HTTP/1.1
+
GET /legacyclients/3201926/report HTTP/1.1
 
Host: p.lssdev.com
 
Host: p.lssdev.com
 
x-api-token: YOUR_API_KEY
 
x-api-token: YOUR_API_KEY
Line 20: Line 21:
 
     "success": true,
 
     "success": true,
 
     "error": null,
 
     "error": null,
−
     "data": "report initiated"
+
     "data": {
 +
        "baseline_version": "jazz",
 +
        "overview": {
 +
            "baselineOverview": {
 +
                "bingScore": 93,
 +
                "directoriesScore": 31,
 +
                "googleScore": 100,
 +
                "localsScore": 96,
 +
                "napScore": 39,
 +
                "visibilityScore": 59,
 +
                "yelpScore": 94,
 +
                "voiceScore": 72,
 +
                "localsScoreTotal": 287,
 +
                "localsTotal": 3,
 +
                "localsFound": 3,
 +
                "localsNapScore": 96,
 +
                "localsNapTotal": 287,
 +
                "directoriesTotal": 42,
 +
                "directoriesFound": 13,
 +
                "directoriesNapScore": 35,
 +
                "directoriesNapTotal": 1446,
 +
                "voiceTotal": 5,
 +
                "voiceFound": 4
 +
            }
 +
        },
 +
        "data": {
 +
            "baseline": {
 +
                "locals": [
 +
                    {
 +
                        "product": "Bing local",
 +
                        "directory": "bing",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/bing.png",
 +
                        "found": true,
 +
                        "score": 93,
 +
                        "claimed": false,
 +
                        "hours": true,
 +
                        "date": "2021-01-06T21:24:48.000Z",
 +
                        "categories": 0,
 +
                        "reviews": 24,
 +
                        "photos": 1,
 +
                        "website": "https://www.kellysartshack.com/",
 +
                        "link": "https://www.bing.com/maps?ss=ypid.YN873x2705681487866994578",
 +
                        "phone": "(214) 935-8891",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 Cloyd St, McKinney, TX 75069",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 96,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Google",
 +
                        "directory": "google",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/google.png",
 +
                        "found": true,
 +
                        "score": 100,
 +
                        "claimed": true,
 +
                        "hours": true,
 +
                        "date": "2021-01-06T21:24:46.000Z",
 +
                        "categories": 2,
 +
                        "reviews": 5,
 +
                        "photos": 1,
 +
                        "website": "https://www.kellysartshack.com/",
 +
                        "link": "https://maps.google.com/?cid=14732555693742418082",
 +
                        "phone": "(214) 935-8891",
 +
                        "name": "Kelly's Art Shack & Events",
 +
                        "address": "312 E Cloyd St, McKinney, TX 75069, USA",
 +
                        "nap": {
 +
                            "name": 100,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Yelp",
 +
                        "directory": "yelp",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/yelp.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "claimed": true,
 +
                        "hours": true,
 +
                        "date": "2021-01-06T21:24:46.000Z",
 +
                        "categories": 7,
 +
                        "reviews": 2,
 +
                        "photos": 1,
 +
                        "website": "kellysartshack.com",
 +
                        "link": "https://www.yelp.com/biz/kellys-art-shack-mckinney-2",
 +
                        "phone": "(214) 935-8891",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 E Cloyd St, McKinney, TX 75069",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    }
 +
                ],
 +
                "directories": [
 +
                    {
 +
                        "product": "Alignable",
 +
                        "type": "directory",
 +
                        "directory": "alignable",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/alignable.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Apple",
 +
                        "type": "ftp",
 +
                        "directory": "apple",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/apple.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Brownbook",
 +
                        "directory": "brownbook",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/brownbook.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:48.000Z",
 +
                        "link": "https://brownbook.net/business/46687008/kellys-art-shack",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Bubblelife",
 +
                        "directory": "bubblelife",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/bubblelife.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:48.000Z",
 +
                        "link": "http://directory.bubblelife.com/listing/351732674/Kellys_Art_Shack",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX, 75069",
 +
                        "phone": "2149358891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Cataloxy",
 +
                        "type": "directory",
 +
                        "directory": "cataloxy",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cataloxy.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Chamberofcommerce",
 +
                        "directory": "chamberofcommerce",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/chamberofcommerce.png",
 +
                        "found": true,
 +
                        "score": 80,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:46.000Z",
 +
                        "link": "https://www.chamberofcommerce.com/united-states/texas/mckinney/art-studios/2011504185-kellys-art-shack",
 +
                        "name": "Kelly's Art ShackKelly's Art Shack",
 +
                        "address": "312 East Cloyd Street Mckinney, TX 75069, 312 East Cloyd Street Mckinney, TX 75069",
 +
                        "phone": "(214) 935-8891(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 71,
 +
                            "address": 68,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Citysearch",
 +
                        "type": "directory",
 +
                        "directory": "citysearch",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/citysearch.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:43.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Citysquares",
 +
                        "directory": "citysquares",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/citysquares.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:46.000Z",
 +
                        "link": "https://citysquares.com/b/kelly-s-art-shack-23512625",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, Mckinney, Texas, 75069",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Cylex",
 +
                        "directory": "cylex",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cylex.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:43.000Z",
 +
                        "link": "https://www.cylex.us.com/company/kelly%27s-art-shack-28002736.html",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
 +
                        "phone": "2149358891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Dataprovider",
 +
                        "type": "aggregator",
 +
                        "directory": "dataprovider",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/dataprovider.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:41.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Dnb",
 +
                        "type": "ftp",
 +
                        "directory": "dnb",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/dnb.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:57.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Ebusinesspages",
 +
                        "directory": "ebusinesspages",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/ebusinesspages.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:57.000Z",
 +
                        "link": "http://ebusinesspages.com/Kellys-Art-Shack_e4bp6.co",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, Mckinney, TX 75069",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Elocal",
 +
                        "directory": "elocal",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/elocal.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:51.000Z",
 +
                        "link": "https://www.elocal.com/profile/kellya-s-art-shack-20346625/#!/category=319",
 +
                        "name": "Kelly’s Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX, 75069",
 +
                        "phone": "214-935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Enrollbusiness",
 +
                        "type": "directory",
 +
                        "directory": "enrollbusiness",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/enrollbusiness.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Expressbusinessdirectory",
 +
                        "type": "directory",
 +
                        "directory": "expressbusinessdirectory",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/expressbusinessdirectory.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:51.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Ezlocal",
 +
                        "type": "directory",
 +
                        "directory": "ezlocal",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/ezlocal.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:46.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Factual",
 +
                        "type": "directory",
 +
                        "directory": "factual",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/factual.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:41.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Findopen",
 +
                        "type": "directory",
 +
                        "directory": "findopen",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/findopen.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:44.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Foursquare",
 +
                        "directory": "foursquare",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/foursquare.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "aggregator",
 +
                        "date": "2021-01-06T21:24:51.000Z",
 +
                        "link": "https://foursquare.com/v/kellys-art-shack/5d553f77e8791a0008842e43",
 +
                        "name": "Kelly’s Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX 75069, United States",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Here",
 +
                        "type": "directory",
 +
                        "directory": "here",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/here.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Hotfrog",
 +
                        "type": "directory",
 +
                        "directory": "hotfrog",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/hotfrog.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Hubbiz",
 +
                        "type": "directory",
 +
                        "directory": "hubbiz",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/hubbiz.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:43.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Ibegin",
 +
                        "directory": "ibegin",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/ibegin.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:44.000Z",
 +
                        "link": "https://www.ibegin.com/directory/visit/17037905",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, Mckinney, Texas 75069",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Infobel",
 +
                        "directory": "infobel",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/infobel.png",
 +
                        "found": true,
 +
                        "score": 59,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:43.000Z",
 +
                        "link": "https://www.us-info.com/en/usa/kelly_s_art_shack/mckinney/USTX102328767-2149358891/businessdetails.aspx",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 Cloyd St, 75069 McKinney, Texas",
 +
                        "phone": "xIjh3b3+UefOQSaI5zdaQbBDIlsYdssNpJf2njXaJhY=",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 96,
 +
                            "phone": 0
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Infogroup",
 +
                        "type": "aggregator",
 +
                        "directory": "infogroup",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/infogroup.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:58.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Invalid",
 +
                        "type": "directory",
 +
                        "directory": "invalid",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/invalid.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:50.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Judysbook",
 +
                        "directory": "judysbook",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/judysbook.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:43.000Z",
 +
                        "link": "https://www.judysbook.com/Kellys-Art-Shack-Art-Studios-mckinney-tx-r39944456.htm",
 +
                        "name": "Kelly’s Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
 +
                        "phone": "2149358891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Localeze",
 +
                        "directory": "localeze",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/localeze.png",
 +
                        "found": true,
 +
                        "score": 93,
 +
                        "type": "aggregator",
 +
                        "date": "2021-01-06T21:24:42.000Z",
 +
                        "link": "https://www.neustarlocaleze.biz/directory/us/tx/mckinney/kellys-art-shack/906054103/",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 Cloyd St, Mckinney, TX, 75069",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 96,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Localmint",
 +
                        "type": "directory",
 +
                        "directory": "localmint",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/localmint.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:44.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Localstack",
 +
                        "directory": "localstack",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/localstack.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:43.000Z",
 +
                        "link": "https://localstack.com/biz/kellys-art-shack-mckinney-tx/3568539",
 +
                        "name": "Kellys Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
 +
                        "phone": "(214) 935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Merchantcircle",
 +
                        "directory": "merchantcircle",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/merchantcircle.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:50.000Z",
 +
                        "link": "https://www.merchantcircle.com/kelly-s-art-shack-mckinney-tx",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX, 75069",
 +
                        "phone": "214-935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "N49",
 +
                        "type": "directory",
 +
                        "directory": "n49",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/n49.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:41.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Opendi",
 +
                        "type": "directory",
 +
                        "directory": "opendi",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/opendi.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:59.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Showmelocal",
 +
                        "directory": "showmelocal",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/showmelocal.png",
 +
                        "found": true,
 +
                        "score": 94,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:50.000Z",
 +
                        "link": "https://www.showmelocal.com/profile.aspx?bid=23095653",
 +
                        "name": "Kelly's Art Shack",
 +
                        "address": "312 East Cloyd Street, Mckinney, TX, 75069",
 +
                        "phone": "(214)935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 100,
 +
                            "phone": 100
 +
                        }
 +
                    },
 +
                    {
 +
                        "product": "Sitecards",
 +
                        "type": "directory",
 +
                        "directory": "sitecards",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/sitecards.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:50.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Superpages",
 +
                        "type": "directory",
 +
                        "directory": "superpages",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/superpages.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:48.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Tupalo",
 +
                        "type": "directory",
 +
                        "directory": "tupalo",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/tupalo.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:43.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Uscity",
 +
                        "type": "directory",
 +
                        "directory": "uscity",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/uscity.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Verizon411",
 +
                        "type": "ftp",
 +
                        "directory": "verizon411",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/verizon411.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Whereto",
 +
                        "type": "directory",
 +
                        "directory": "whereto",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/whereto.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:42.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Wherezit",
 +
                        "type": "directory",
 +
                        "directory": "wherezit",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/wherezit.png",
 +
                        "found": false,
 +
                        "date": "2021-01-06T21:24:41.000Z"
 +
                    },
 +
                    {
 +
                        "product": "Yasabe",
 +
                        "directory": "yasabe",
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/yasabe.png",
 +
                        "found": true,
 +
                        "score": 86,
 +
                        "type": "directory",
 +
                        "date": "2021-01-06T21:24:42.000Z",
 +
                        "link": "https://www.dev.yasabe.com/en/mckinney-tx/d-1000000963797-kellys-art-shack.html",
 +
                        "name": "Kellys Art Shack",
 +
                        "address": "312 East Cloyd Street, McKinney, TX",
 +
                        "phone": "(214)-935-8891",
 +
                        "nap": {
 +
                            "name": 82,
 +
                            "address": 75,
 +
                            "phone": 100
 +
                        }
 +
                    }
 +
                ],
 +
                "voice": [
 +
                    {
 +
                        "device": "google",
 +
                        "name": "Google Assistant",
 +
                        "score": 100,
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/google-home.png"
 +
                    },
 +
                    {
 +
                        "device": "siri",
 +
                        "name": "Apple Siri",
 +
                        "score": 0,
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/Siri-logo.png"
 +
                    },
 +
                    {
 +
                        "device": "bixby",
 +
                        "name": "Samsung Bixby",
 +
                        "score": 75,
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/Bixby.png"
 +
                    },
 +
                    {
 +
                        "device": "alexa",
 +
                        "name": "Amazon Alexa",
 +
                        "score": 75,
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/amazon-alexa.png"
 +
                    },
 +
                    {
 +
                        "device": "cortana",
 +
                        "name": "Microsoft Cortana",
 +
                        "score": 75,
 +
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cortana-logo.png"
 +
                    }
 +
                ]
 +
            }
 +
        },
 +
        "products": []
 +
    }
 +
}
 +
</syntaxhighlight>
 +
 
 +
== General Rollup Report ==
 +
This endpoint returned client rollup report averages, sum totals, and count.
 +
=== API Endpoint ===
 +
<syntaxhighlight lang="html">
 +
https://praxis.lssdev.com/api/v2/partner/{partner_id}/rollup/get-scores/
 +
</syntaxhighlight>
 +
 
 +
=== Example Request ===
 +
<syntaxhighlight lang="php">
 +
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
 +
</syntaxhighlight>
 +
 
 +
=== Example Response ===
 +
<syntaxhighlight lang="json">
 +
{
 +
    "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
 +
    }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
−
== Directory Data Report ==
+
 
 +
 
 +
== 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 ===
 
=== API Endpoint ===
 
<syntaxhighlight lang="html">
 
<syntaxhighlight lang="html">
−
http://p.lssdev.com/legacydirectorydata?client={client_id}
+
https://p.lssdev.com/legacyinsightdata?client={clientid}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== Example Request ===
 
=== Example Request ===
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
−
GET /legacydirectorydata?client=3201926 HTTP/1.1
+
GET /legacyinsightdata?client={clientid} HTTP/1.1
 
Host: p.lssdev.com
 
Host: p.lssdev.com
 
x-api-token: YOUR_API_KEY
 
x-api-token: YOUR_API_KEY
Line 45: Line 753:
 
     "data": [
 
     "data": [
 
         {
 
         {
−
             "client": 3201926,
+
             "client": 123,
−
             "partner": 7,
+
             "partner": 123456,
−
             "data": {
+
            "id": 3,
−
                 "dirName": "Chamberofcommerce",
+
            "store_code": 0,
−
                 "dirHandle": "chamberofcommerce",
+
            "LA_score": 36,
−
                 "dirQuery": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
+
            "brand_score": 0,
−
                 "results": 4,
+
            "influence_score": 100,
−
                 "result": [
+
            "listing_score": 80,
 +
            "reputation_score": 0,
 +
            "engagement_score": 0,
 +
            "website_visits": 0,
 +
            "phone_calls_clicks": 0,
 +
            "phone_calls_tracked": 0,
 +
            "directions": 0,
 +
            "calls_directions": 0,
 +
            "conv_rate": 0,
 +
            "total_conversions": 0,
 +
            "avg_sale_price": 0,
 +
            "potential_revenue": 0,
 +
            "investment": 0,
 +
            "potential_roi": 0,
 +
            "review_rating": 0,
 +
            "photo_views": 28,
 +
            "discovery_impressions": 6,
 +
            "direct_impressions": 0,
 +
            "chain_impressions": 0,
 +
            "search_impressions_from_chain": 0,
 +
            "listing_views": 6,
 +
            "total_calls": 0,
 +
            "first_time_caller": 0,
 +
            "duration_seconds": 0,
 +
            "active_location": 0,
 +
            "cost_per_location": 0,
 +
            "total_impressions": 6,
 +
            "total_actions": 0,
 +
            "cost_per_actions": 0,
 +
            "createdAt": "2020-05-14T19:26:58.000Z",
 +
            "recordedAt": "2020-05-07T12:00:00.000Z",
 +
            "updatedAt": "2020-05-14T19:27:31.000Z"
 +
        }
 +
    ]
 +
}
 +
</syntaxhighlight>
 +
 
 +
 
 +
== Voice Data ==
 +
This endpoint provides information on voice enabled locations via the AdVoice product. All 3 query parameters are required.  Unlike the other endpoints in our system, there are no conditionals that you can include in the request.  The data returned is always an aggregate.  You are free to set any range you wish and the endpoint will provide the totals for you.
 +
 
 +
=== API Endpoint ===
 +
<syntaxhighlight lang="html">
 +
https://p.lssdev.com/legacyvoicedata?client={clientid}&startDate={startDate}&endDate={endDate}
 +
</syntaxhighlight>
 +
 
 +
=== Example Request ===
 +
<syntaxhighlight lang="php">
 +
GET /legacyvoicedata?client={clientid}&startDate=2020-01-01&endDate=2020-07-01 HTTP/1.1
 +
Host: p.lssdev.com
 +
x-api-token: YOUR_API_KEY
 +
Content-Type: application/json
 +
</syntaxhighlight>
 +
 
 +
=== Example Response ===
 +
<syntaxhighlight lang="json">
 +
{
 +
    "status": 200,
 +
    "success": true,
 +
    "error": null,
 +
    "data": {
 +
        "users_total": 115,
 +
        "sessions_total": 210,
 +
        "requests_total": 726,
 +
        "users": [
 +
            {
 +
                "count": 41,
 +
                "assistant": "GoogleAssistant"
 +
            },
 +
            {
 +
                "count": 74,
 +
                "assistant": "Alexa"
 +
            }
 +
        ],
 +
        "requests": [
 +
            {
 +
                "count": 41,
 +
                "assistant": "GoogleAssistant"
 +
            },
 +
            {
 +
                "count": 74,
 +
                "assistant": "Alexa"
 +
            }
 +
        ]
 +
    }
 +
}
 +
</syntaxhighlight>
 +
 
 +
 
 +
== Review Data ==
 +
This endpoint provides a large JSON object with aggregate statistics as well as a sample set of recent review objects.  This endpoint is only available for locations with active orders.
 +
 
 +
=== API Endpoint ===
 +
<syntaxhighlight lang="html">
 +
https://p.lssdev.com/legacyclients/{clientid}/reviews
 +
</syntaxhighlight>
 +
 
 +
=== Example Request ===
 +
<syntaxhighlight lang="php">
 +
GET /legacyclients/3782992/reviews HTTP/1.1
 +
Host: p.lssdev.com
 +
x-api-token: YOUR_API_KEY
 +
Content-Type: application/json
 +
</syntaxhighlight>
 +
 
 +
=== Example Response ===
 +
<syntaxhighlight lang="json">
 +
 
 +
{
 +
    "status": 200,
 +
    "success": true,
 +
    "error": null,
 +
    "data": {
 +
        "reviews": 21,
 +
        "score": {
 +
            "total": 4.85,
 +
            "months_1": 4.85,
 +
            "months_6": 4.85
 +
        },
 +
        "recency": {
 +
            "total": 0,
 +
            "week_1": 0,
 +
            "months_1": 0,
 +
            "months_2": 0,
 +
            "months_3": 0
 +
        },
 +
        "sentiment": {
 +
            "positive": 75,
 +
            "above_average": 0,
 +
            "neutral": 0,
 +
            "below_average": 1,
 +
            "negative": 0
 +
        },
 +
        "sources": [
 +
            {
 +
                "name": "BrownBook",
 +
                "score": 2,
 +
                "reviews": 1,
 +
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/brownbook.png"
 +
            },
 +
            {
 +
                "name": "Cylex USA",
 +
                "score": 0,
 +
                "reviews": 0,
 +
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cylex.png"
 +
            },
 +
            {
 +
                "name": "Google",
 +
                "score": 5,
 +
                "reviews": 17,
 +
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/google.png"
 +
            },
 +
            {
 +
                "name": "Judy's Book",
 +
                "score": 0,
 +
                "reviews": 0,
 +
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/judysbook.png"
 +
            },
 +
            {
 +
                "name": "ShowMeLocal",
 +
                "score": 0,
 +
                "reviews": 0,
 +
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/showmelocal.png"
 +
            },
 +
            {
 +
                "name": "Yelp",
 +
                "score": 5,
 +
                "reviews": 3,
 +
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/yelp.png"
 +
             }
 +
        ],
 +
        "data": [
 +
            {
 +
                 "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                 "provider": "google",
 +
                 "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
 +
                "reviewer": "Alison Thornton",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "I had an incredible experience at Kelly's Art Shack & Events! The venue was perfect for hosting birthday parties, and the karaoke added a fantastic touch of entertainment. The Arty Party was a blast, and I thoroughly enjoyed painting a lively Tuscan scene. Kelly's Art Shack & Events is definitely a downtown McKinney gem for art enthusiasts and party-goers alike!",
 +
                "replied": true,
 +
                "id": 33407619,
 +
                "createdAt": "2023-07-12T05:47:07.000Z",
 +
                "reviewKey": "AbFvOqlx3ckOFtjqB498fIWRyzY-ZtOLhRez8hkzFFG2UKCgv0vKhhLwah4HVopX5mfB4nZbJ0YU",
 +
                "reviewedAt": "2023-06-02T17:07:50.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "google",
 +
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
 +
                "reviewer": "Paul Grossman",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Breathtaking art!!! A wonderful place to see, learn from, and grow.",
 +
                "replied": true,
 +
                "id": 33407620,
 +
                "createdAt": "2023-07-12T05:47:07.000Z",
 +
                "reviewKey": "AbFvOqkxwZH_GD9qMaCuVB4zGt2I5sXuRgi0_ok4nmkfASBHP-bLtEhuz7BvyNihW38XI5tSHns3",
 +
                "reviewedAt": "2023-02-16T21:50:47.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "google",
 +
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
 +
                "reviewer": "Linda Nunn",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Kelly is an amazing artist . I have purchased many canvases from her. In addition , she hosts events and is very involved with McKinney life. She features fellow artists as well and promotes great local bands. It is a fun place to visit or book a birthday party or commission Kelly for a mural or canvas for your home.",
 +
                "replied": true,
 +
                "id": 33407616,
 +
                "createdAt": "2023-07-12T05:47:07.000Z",
 +
                "reviewKey": "AbFvOqn4jpaktJNV_A6i4LKWAt1MTuP8uZuzCm0nWmxWDPcCxjmaTP8ZctiJqkMyHHtGkeBHHXOrKw",
 +
                "reviewedAt": "2022-09-13T11:09:29.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "google",
 +
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
 +
                "reviewer": "Letitia Sanchez",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Kelly is a wonderful, professional artist who is a dream to collaborate with. Her art gallery and event venue is a beautiful space.\n\nTonight, Kelly's Art Gallery was the location for Joyland's Speakeasy paint and sip party. Poppy's Wings served catfish with truffle mac & cheese and baked beans. Folks, GET YOU SOME OF EVERYTHING!!!! Run, don't walk.",
 +
                "replied": true,
 +
                "id": 33407632,
 +
                "createdAt": "2023-07-12T05:47:07.000Z",
 +
                "reviewKey": "AbFvOqlWgPK8K77bs21PrqgpOohRorsbnmX9z5eljUPLitkBtdluw3-UCqoUVaQLtAVfZvrFPkLF",
 +
                "reviewedAt": "2022-08-14T04:55:28.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "google",
 +
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
 +
                "reviewer": "Joseph Ortiz",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "",
 +
                "replied": true,
 +
                "id": 33407628,
 +
                "createdAt": "2023-07-12T05:47:07.000Z",
 +
                "reviewKey": "AbFvOqns8q_enfIwdmCMasU8OjeiyHAYZopnNUdB-wo9kUmHVC_2PfpduCvKAntwXiwv0T6oUM4YJA",
 +
                "reviewedAt": "2022-08-03T16:46:36.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "brownbook",
 +
                "url": "https://www.brownbook.net/business/49380379/kellys-art-shack-events",
 +
                "reviewer": "Dr. Franklin Perry",
 +
                "sentiment": null,
 +
                "score": 2,
 +
                "comment": "Did a great job on my commissioned artwork",
 +
                "replied": false,
 +
                "id": 38046,
 +
                "createdAt": "2022-09-21T17:59:05.000Z",
 +
                "reviewKey": "603793",
 +
                "reviewedAt": "2022-05-03T19:18:52.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147837",
 +
                "reviewer": "William Marcus",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                 "comment": "The fitters came on time, worked quickly and cleanly. Care and operation of the air conditioner were also explained to us in a way that was easy to understand. Thanks a lot for Air Track. Gladly again.",
 +
                "replied": false,
 +
                "id": 21,
 +
                "createdAt": "2022-06-21T21:47:58.000Z",
 +
                "reviewKey": "CA147837",
 +
                "reviewedAt": "2022-03-07T10:16:46.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147599",
 +
                "reviewer": "Jay J. Jones",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Just had Air track Inc in to replace an old HVAC unit. Director Frank was outstanding! He’s honest, gives you his opinion yet respects your needs. Extremely kind and courteous with almost 40 years of experience, the work completed was outstanding. Definitely recommend them.",
 +
                "replied": false,
 +
                "id": 24,
 +
                "createdAt": "2022-06-21T21:47:58.000Z",
 +
                "reviewKey": "CA147599",
 +
                "reviewedAt": "2022-01-18T12:16:57.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "google",
 +
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
 +
                "reviewer": "latasha whalen",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "",
 +
                "replied": true,
 +
                "id": 33407622,
 +
                "createdAt": "2023-07-12T05:47:07.000Z",
 +
                "reviewKey": "AbFvOqmp3Rwzi0ReMLaVJWUe163LOHL6ke9xgJOZD_vHMqn-q74IEl7P9qVYLd1fiPvBgCs8a-wv",
 +
                "reviewedAt": "2022-01-09T00:35:09.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147474",
 +
                "reviewer": "Kyle Butler",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Excellent Service; after accepting a detailed quote from Frank, our replacement combo boiler was installed 3 days later. They demonstrated how to manage the boiler &amp; wireless controller before removing the old boiler &amp; tidying up before leaving.. I would definitely recommend Air Track Inc.",
 +
                "replied": false,
 +
                "id": 37,
 +
                "createdAt": "2022-06-21T21:48:02.000Z",
 +
                "reviewKey": "CA147474",
 +
                "reviewedAt": "2021-12-29T18:18:37.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147452",
 +
                "reviewer": "Ivan Cohen",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Fantastic throughout. Very professional, kept us well informed, worked well with the other people working on our basement and took a huge amount of pride in their work. Very highly recommended.",
 +
                "replied": false,
 +
                "id": 41,
 +
                "createdAt": "2022-06-21T21:48:03.000Z",
 +
                "reviewKey": "CA147452",
 +
                "reviewedAt": "2021-12-24T11:38:14.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147355",
 +
                "reviewer": "Christopher Fonville",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Excellent service..My 5 month old boiler stopped working. Frank turned up on time , resolved the problem really quickly,it wasnt the boiler but one of two options, both of he pointed out to me and were a quick fix . Thank you for your help and time .",
 +
                "replied": false,
 +
                "id": 39,
 +
                "createdAt": "2022-06-21T21:48:02.000Z",
 +
                "reviewKey": "CA147355",
 +
                "reviewedAt": "2021-12-01T13:37:21.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147345",
 +
                "reviewer": "Kristen Spearman",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "I recommend Air Track Inc to everyone. They fulfilled the agreement with excellence of professionalism. Excellent professional!  They handle the equipment very carefully to protect the same. Attentive, punctual, clean service. I confirm the other positive evaluations of this professional. Also for the fast service for getting it done. We were so pleased with their service and we used them again.",
 +
                "replied": false,
 +
                "id": 27,
 +
                "createdAt": "2022-06-21T21:47:59.000Z",
 +
                "reviewKey": "CA147345",
 +
                "reviewedAt": "2021-11-30T10:42:22.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147192",
 +
                "reviewer": "Maverick Erickson",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Customer service is still very important here - friendly, competent and punctual. Thank you Air Track.",
 +
                "replied": false,
 +
                "id": 1,
 +
                "createdAt": "2022-06-21T21:47:55.000Z",
 +
                "reviewKey": "CA147192",
 +
                "reviewedAt": "2021-11-08T10:53:58.000Z"
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "batch": null,
 +
                "provider": "cylex",
 +
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147122",
 +
                "reviewer": "Roman Prince",
 +
                "sentiment": null,
 +
                "score": 5,
 +
                "comment": "Air Track team work was good.Great expertise - especially when it comes to air conditioning systems from Our Company. Fair in price. You are in good hands there!. Thanks to Air Track INC.",
 +
                "replied": false,
 +
                "id": 5,
 +
                "createdAt": "2022-06-21T21:47:55.000Z",
 +
                "reviewKey": "CA147122",
 +
                "reviewedAt": "2021-10-26T12:30:42.000Z"
 +
            }
 +
        ],
 +
        "summaries": [
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "directory": "brownbook",
 +
                "rating": 2,
 +
                "id": 98,
 +
                "createdAt": "2022-07-26T00:28:51.000Z",
 +
                "errorAt": null,
 +
                "updatedAt": "2023-12-15T07:03:08.000Z",
 +
                "reviews": 1,
 +
                "maxRating": 2
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "directory": "cylex",
 +
                "rating": 0,
 +
                "id": 6,
 +
                "createdAt": "2022-07-25T22:26:56.000Z",
 +
                "errorAt": null,
 +
                "updatedAt": "2023-12-15T07:03:39.000Z",
 +
                "reviews": 0,
 +
                "maxRating": 0
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "directory": "google",
 +
                "rating": 5,
 +
                "id": 25028,
 +
                "createdAt": "2022-09-06T17:19:06.000Z",
 +
                "errorAt": null,
 +
                "updatedAt": "2023-12-15T07:02:42.000Z",
 +
                "reviews": 17,
 +
                "maxRating": 5
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "directory": "judysbook",
 +
                "rating": 0,
 +
                "id": 83,
 +
                "createdAt": "2022-07-26T00:25:35.000Z",
 +
                "errorAt": null,
 +
                "updatedAt": "2023-12-15T06:58:02.000Z",
 +
                "reviews": 0,
 +
                "maxRating": 0
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "directory": "showmelocal",
 +
                "rating": 0,
 +
                "id": 95,
 +
                "createdAt": "2022-07-26T00:28:51.000Z",
 +
                "errorAt": null,
 +
                "updatedAt": "2023-12-15T07:03:13.000Z",
 +
                "reviews": 0,
 +
                "maxRating": 0
 +
            },
 +
            {
 +
                "client": 3782992,
 +
                "partner": 45803,
 +
                "directory": "yelp",
 +
                "rating": 5,
 +
                "id": 24709,
 +
                "createdAt": "2022-09-06T17:18:29.000Z",
 +
                "errorAt": null,
 +
                "updatedAt": "2023-12-15T07:01:46.000Z",
 +
                "reviews": 3,
 +
                "maxRating": 5
 +
            }
 +
        ]
 +
    }
 +
}
 +
 
 +
</syntaxhighlight>
 +
 
 +
 
 +
== Keyword Data ==
 +
This endpoint provides reporting on keyword organic rankings as well as a map grid chart centered around the business.  Aside from the current "grid" and ranking data, there are histories for both. The "grid_history" property retains a list of all the data refreshed every Friday and does not the most recent set of data.  The organic ranking data however does include the current ranking.  The rank_history property is ordered from the most recent to oldest.
 +
=== API Endpoint ===
 +
<syntaxhighlight lang="html">
 +
https://p.lssdev.com/legacykeywords/{clientid}
 +
</syntaxhighlight>
 +
 
 +
=== Example Request ===
 +
<syntaxhighlight lang="php">
 +
GET /legacykeywords/3782992 HTTP/1.1
 +
Host: p.lssdev.com
 +
x-api-token: YOUR_API_KEY
 +
Content-Type: application/json
 +
</syntaxhighlight>
 +
 
 +
 
 +
<syntaxhighlight lang="json">
 +
{
 +
    "status": 200,
 +
    "success": true,
 +
    "error": null,
 +
    "data": [
 +
    {
 +
        "processing": false,
 +
        "keyword": "art dealer",
 +
        "grid_id": 5979,
 +
        "grid": [
 +
            {
 +
                "LAT": 33.4145,
 +
                "LON": -96.3518,
 +
                "rank": 0,
 +
                "point": "-3,-3"
 +
            },
 +
            {
 +
                "LAT": 33.4145,
 +
                "LON": -96.4388,
 +
                "rank": 7,
 +
                "point": "-3,-2"
 +
            },
 +
            {
 +
                "LAT": 33.4145,
 +
                "LON": -96.5258,
 +
                "rank": 0,
 +
                "point": "-3,-1"
 +
            }
 +
       
 +
        ],
 +
        "LAT": 33.197,
 +
        "LON": -96.6128,
 +
        "thedate": "2024-08-01 18:51:46",
 +
        "grid_distance": 5,
 +
        "history": [
 +
            {
 +
                 "grid": [
 
                     {
 
                     {
−
                         "link": "https://www.chamberofcommerce.com/newport-beach-ca/25230470-ginas-pizza",
+
                         "LAT": 33.4145,
−
                         "methods": {
+
                         "LON": -96.3518,
−
                            "url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
+
                         "rank": 0,
−
                            "enclosure": "main-content",
+
                         "point": "-3,-3"
−
                            "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",
+
                         "LAT": 33.4145,
−
                         "methods": {
+
                         "LON": -96.4388,
−
                            "url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
+
                         "rank": 0,
−
                            "enclosure": "main-content",
+
                         "point": "-3,-2"
−
                            "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",
+
                         "LAT": 33.4145,
−
                         "methods": {
+
                         "LON": -96.5258,
−
                            "url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
+
                         "rank": 0,
−
                            "enclosure": "main-content",
+
                         "point": "-3,-1"
−
                            "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": {
+
                 "grid_id": 5970,
−
                            "url": "https://www.chamberofcommerce.com/search/results?what=gina%27s+pizza&where=newport+beach%2C+ca",
+
                 "date": "2024-08-01 18:51:41",
−
                            "enclosure": "main-content",
+
                "rank": 7
−
                            "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
 
 
}
 
}
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
== Local Data Report ==
+
=== API Endpoint to Start Tracking Keyword ===
−
=== API Endpoint ===
+
You can add new keywords and location to start tracking.  The keywords to not have to match the keywords of your client data.  The location can be different as well.  For example, your business may be in Dallas Texas but you may wish to start tracking keyword rankings for the neighboring city of McKinney Texas.
 
<syntaxhighlight lang="html">
 
<syntaxhighlight lang="html">
−
http://p.lssdev.com/legacylocaldata?client={client_id}
+
https://p.lssdev.com/legacykeywords/{clientid}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== Example Request ===
 
=== Example Request ===
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
−
GET /legacylocaldata?client=3201926 HTTP/1.1
+
POST /legacykeywords/3782992 HTTP/1.1
 
Host: p.lssdev.com
 
Host: p.lssdev.com
 
x-api-token: YOUR_API_KEY
 
x-api-token: YOUR_API_KEY
 
Content-Type: application/json
 
Content-Type: application/json
 +
 +
{ keyword }
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== Example Response ===
 
=== Example Response ===
 
<syntaxhighlight lang="json">
 
<syntaxhighlight lang="json">
 +
 
{
 
{
 +
    "status": 200,
 +
    "success": true,
 +
    "error": null,
 +
    "data": {
 
     "status": 200,
 
     "status": 200,
 
     "success": true,
 
     "success": true,
Line 241: Line 1,368:
 
     "data": [
 
     "data": [
 
         {
 
         {
−
             "client": 3201926,
+
             "processing": false,
−
             "partner": 7,
+
             "keyword": "art dealer",
−
             "link": "http://www.yelp.com/biz/ginas-pizza-newport-beach-2?osq=Gina%27s+Pizza",
+
             "grid_id": 5979,
−
             "claimed": "null",
+
             "grid": [
−
            "hours": "true",
+
                {
−
            "description": "null",
+
                    "LAT": 33.4145,
−
            "categories": 3,
+
                    "LON": -96.3518,
−
            "photos": 0,
+
                    "rank": 0,
−
            "website": "http://ginaspizza.com",
+
                    "point": "-3,-3"
−
            "n": "Gina?s Pizza",
+
                },
−
            "a": "3142 W Balboa Blvd Newport Beach, CA 92663",
+
                {
−
            "p": "(949) 723-4462",
+
                    "LAT": 33.4145,
−
            "id": 6945921,
+
                    "LON": -96.4388,
−
            "createdAt": "2017-12-13T22:08:39.000Z",
+
                    "rank": 7,
−
            "directory": "yelp",
+
                    "point": "-3,-2"
−
            "batch": "3201926-2017-12-13 22:08:39",
+
                },
−
            "nScore": 100,
+
                {
−
             "aScore": 100,
+
                    "LAT": 33.4145,
−
             "pScore": 100,
+
                    "LON": -96.5258,
−
             "napScore": 100,
+
                    "rank": 0,
−
             "data": {
+
                    "point": "-3,-1"
−
                "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",
+
             "LAT": 33.197,
−
                "local": {
+
             "LON": -96.6128,
−
                    "website": "ginaspizza.com",
+
             "thedate": "2024-08-01 18:51:46",
−
                    "categories": [
+
            "grid_distance": 5,
−
                        "pizza",
+
            "history": [
−
                        "italian",
+
                {
−
                        "sandwiches"
+
                     "grid": [
−
                    ],
 
−
                     "opening_hours": [
 
 
                         {
 
                         {
−
                             "day": "Mon",
+
                             "LAT": 33.4145,
−
                             "open": "11:00 am",
+
                            "LON": -96.3518,
−
                             "close": "9:30 pm"
+
                             "rank": 0,
 +
                             "point": "-3,-3"
 
                         },
 
                         },
 
                         {
 
                         {
−
                             "day": "Tue",
+
                             "LAT": 33.4145,
−
                             "open": "11:00 am",
+
                            "LON": -96.4388,
−
                             "close": "9:30 pm"
+
                             "rank": 0,
 +
                             "point": "-3,-2"
 
                         },
 
                         },
 
                         {
 
                         {
−
                             "day": "Wed",
+
                             "LAT": 33.4145,
−
                             "open": "11:00 am",
+
                            "LON": -96.5258,
−
                             "close": "9:30 pm"
+
                             "rank": 0,
 +
                             "point": "-3,-1"
 
                         },
 
                         },
−
                        {
+
                   
−
                            "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",
+
                     "grid_id": 5970,
−
                     "reviews": 194
+
                    "date": "2024-08-01 18:51:41",
 +
                     "ranking": null
 
                 },
 
                 },
−
                "reputation": {
+
         
−
                    "rating": "3.0",
+
    ]
−
                    "reviews": 194,
+
}
−
                    "contents": [
+
}
−
                        {
+
 
−
                            "author": "Nijole T.",
+
</syntaxhighlight>
−
                            "avatar": "",
+
 
−
                            "rated": "4.0",
+
=== API Endpoint to Delete Single Keyword ===
−
                            "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.",
+
This will delete a single keyword from the list of keyword campaigns from the
−
                            "date": "2017-07-25 00:00:00"
+
 
−
                        },
+
<syntaxhighlight lang="html">
−
                        {
+
https://p.lssdev.com/legacykeywords/{clientid}/{keyword}
−
                            "author": "Michael F.",
+
</syntaxhighlight>
−
                            "avatar": "",
+
 
−
                            "rated": "2.0",
+
=== Example Request ===
−
                            "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",
+
<syntaxhighlight lang="php">
−
                            "date": "2017-10-26 00:00:00"
+
DELETE /legacykeywords/3782992/grooming HTTP/1.1
−
                        },
+
Host: p.lssdev.com
−
                        {...},
+
x-api-token: YOUR_API_KEY
−
                        {...}
+
Content-Type: application/json
−
                    ]
+
 
−
                }
+
</syntaxhighlight>
−
            }
+
 
−
        },
+
=== Example Response ===
−
        {
+
<syntaxhighlight lang="json">
−
            "client": 3201926,
+
 
−
            "partner": 7,
+
{
−
            "link": "https://www.google.com/maps?cid=15412785221185897851",
+
    "status": 200,
−
            "claimed": "true",
+
    "success": true,
−
            "hours": "true",
+
    "error": null,
−
            "description": "null",
+
     "data": true
−
            "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
 
 
}
 
}
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
== Monthly Progress Report ==
+
 
−
The monthly report includes a Visibility Score showing the average of your Google+ Local, Yelp Local, Bing Places, and Directory Scores.
+
=== API Endpoint to Reset All Keywords ===
−
=== API Endpoint ===
+
If you wish to stop all the tracking campaigns, you can call this reset endpoint which will re-allocate the number any keyword campaigns you have per your location.
 
<syntaxhighlight lang="html">
 
<syntaxhighlight lang="html">
−
http://p.lssdev.com/legacyclients/{client_id}/summary
+
https://p.lssdev.com/legacykeywords/{clientid}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== Example Request ===
 
=== Example Request ===
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
−
GET /legacyclients/3201926/summary HTTP/1.1
+
DELETE /legacykeywords/3782992 HTTP/1.1
 
Host: p.lssdev.com
 
Host: p.lssdev.com
 
x-api-token: YOUR_API_KEY
 
x-api-token: YOUR_API_KEY
Line 527: Line 1,475:
 
=== Example Response ===
 
=== Example Response ===
 
<syntaxhighlight lang="json">
 
<syntaxhighlight lang="json">
 +
 
{
 
{
 
     "status": 200,
 
     "status": 200,
 
     "success": true,
 
     "success": true,
 
     "error": null,
 
     "error": null,
−
     "data": {
+
     "data": true
−
        "baseline": {
 
−
            "bingScore": 0,
 
−
            "directoriesScore": 0,
 
−
            "gmbScore": 100,
 
−
            "visibilityScore": 23,
 
−
            "yelpScore": 100
 
−
        },
 
−
        "monthly": {
 
−
            "bingScore": 97,
 
−
            "directoriesScore": 92,
 
−
            "gmbScore": 100,
 
−
            "visibilityScore": 95,
 
−
            "yelpScore": 100
 
−
        }
 
−
    }
 
 
}
 
}
 +
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 13:11, 12 August 2024

Get Client Report

This endpoint will return a large object that contains data.overview and data.data properties. Within each of those properties is baseline data, and optionally monthly progress data if the location is active with products and services. The overview section corresponds to the scores that can be seen on the baseline report within the dashboards. The data.data property has the individual scores and flags for each directory and local scan.

API Endpoint

http://p.lssdev.com/legacyclients/{client_id}/report

Example Request

GET /legacyclients/3201926/report 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": {
        "baseline_version": "jazz",
        "overview": {
            "baselineOverview": {
                "bingScore": 93,
                "directoriesScore": 31,
                "googleScore": 100,
                "localsScore": 96,
                "napScore": 39,
                "visibilityScore": 59,
                "yelpScore": 94,
                "voiceScore": 72,
                "localsScoreTotal": 287,
                "localsTotal": 3,
                "localsFound": 3,
                "localsNapScore": 96,
                "localsNapTotal": 287,
                "directoriesTotal": 42,
                "directoriesFound": 13,
                "directoriesNapScore": 35,
                "directoriesNapTotal": 1446,
                "voiceTotal": 5,
                "voiceFound": 4
            }
        },
        "data": {
            "baseline": {
                "locals": [
                    {
                        "product": "Bing local",
                        "directory": "bing",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/bing.png",
                        "found": true,
                        "score": 93,
                        "claimed": false,
                        "hours": true,
                        "date": "2021-01-06T21:24:48.000Z",
                        "categories": 0,
                        "reviews": 24,
                        "photos": 1,
                        "website": "https://www.kellysartshack.com/",
                        "link": "https://www.bing.com/maps?ss=ypid.YN873x2705681487866994578",
                        "phone": "(214) 935-8891",
                        "name": "Kelly's Art Shack",
                        "address": "312 Cloyd St, McKinney, TX 75069",
                        "nap": {
                            "name": 82,
                            "address": 96,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Google",
                        "directory": "google",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/google.png",
                        "found": true,
                        "score": 100,
                        "claimed": true,
                        "hours": true,
                        "date": "2021-01-06T21:24:46.000Z",
                        "categories": 2,
                        "reviews": 5,
                        "photos": 1,
                        "website": "https://www.kellysartshack.com/",
                        "link": "https://maps.google.com/?cid=14732555693742418082",
                        "phone": "(214) 935-8891",
                        "name": "Kelly's Art Shack & Events",
                        "address": "312 E Cloyd St, McKinney, TX 75069, USA",
                        "nap": {
                            "name": 100,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Yelp",
                        "directory": "yelp",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/yelp.png",
                        "found": true,
                        "score": 94,
                        "claimed": true,
                        "hours": true,
                        "date": "2021-01-06T21:24:46.000Z",
                        "categories": 7,
                        "reviews": 2,
                        "photos": 1,
                        "website": "kellysartshack.com",
                        "link": "https://www.yelp.com/biz/kellys-art-shack-mckinney-2",
                        "phone": "(214) 935-8891",
                        "name": "Kelly's Art Shack",
                        "address": "312 E Cloyd St, McKinney, TX 75069",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    }
                ],
                "directories": [
                    {
                        "product": "Alignable",
                        "type": "directory",
                        "directory": "alignable",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/alignable.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Apple",
                        "type": "ftp",
                        "directory": "apple",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/apple.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Brownbook",
                        "directory": "brownbook",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/brownbook.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:48.000Z",
                        "link": "https://brownbook.net/business/46687008/kellys-art-shack",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Bubblelife",
                        "directory": "bubblelife",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/bubblelife.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:48.000Z",
                        "link": "http://directory.bubblelife.com/listing/351732674/Kellys_Art_Shack",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX, 75069",
                        "phone": "2149358891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Cataloxy",
                        "type": "directory",
                        "directory": "cataloxy",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cataloxy.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Chamberofcommerce",
                        "directory": "chamberofcommerce",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/chamberofcommerce.png",
                        "found": true,
                        "score": 80,
                        "type": "directory",
                        "date": "2021-01-06T21:24:46.000Z",
                        "link": "https://www.chamberofcommerce.com/united-states/texas/mckinney/art-studios/2011504185-kellys-art-shack",
                        "name": "Kelly's Art ShackKelly's Art Shack",
                        "address": "312 East Cloyd Street Mckinney, TX 75069, 312 East Cloyd Street Mckinney, TX 75069",
                        "phone": "(214) 935-8891(214) 935-8891",
                        "nap": {
                            "name": 71,
                            "address": 68,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Citysearch",
                        "type": "directory",
                        "directory": "citysearch",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/citysearch.png",
                        "found": false,
                        "date": "2021-01-06T21:24:43.000Z"
                    },
                    {
                        "product": "Citysquares",
                        "directory": "citysquares",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/citysquares.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:46.000Z",
                        "link": "https://citysquares.com/b/kelly-s-art-shack-23512625",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, Mckinney, Texas, 75069",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Cylex",
                        "directory": "cylex",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cylex.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:43.000Z",
                        "link": "https://www.cylex.us.com/company/kelly%27s-art-shack-28002736.html",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
                        "phone": "2149358891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Dataprovider",
                        "type": "aggregator",
                        "directory": "dataprovider",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/dataprovider.png",
                        "found": false,
                        "date": "2021-01-06T21:24:41.000Z"
                    },
                    {
                        "product": "Dnb",
                        "type": "ftp",
                        "directory": "dnb",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/dnb.png",
                        "found": false,
                        "date": "2021-01-06T21:24:57.000Z"
                    },
                    {
                        "product": "Ebusinesspages",
                        "directory": "ebusinesspages",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/ebusinesspages.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:57.000Z",
                        "link": "http://ebusinesspages.com/Kellys-Art-Shack_e4bp6.co",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, Mckinney, TX 75069",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Elocal",
                        "directory": "elocal",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/elocal.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:51.000Z",
                        "link": "https://www.elocal.com/profile/kellya-s-art-shack-20346625/#!/category=319",
                        "name": "Kelly’s Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX, 75069",
                        "phone": "214-935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Enrollbusiness",
                        "type": "directory",
                        "directory": "enrollbusiness",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/enrollbusiness.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Expressbusinessdirectory",
                        "type": "directory",
                        "directory": "expressbusinessdirectory",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/expressbusinessdirectory.png",
                        "found": false,
                        "date": "2021-01-06T21:24:51.000Z"
                    },
                    {
                        "product": "Ezlocal",
                        "type": "directory",
                        "directory": "ezlocal",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/ezlocal.png",
                        "found": false,
                        "date": "2021-01-06T21:24:46.000Z"
                    },
                    {
                        "product": "Factual",
                        "type": "directory",
                        "directory": "factual",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/factual.png",
                        "found": false,
                        "date": "2021-01-06T21:24:41.000Z"
                    },
                    {
                        "product": "Findopen",
                        "type": "directory",
                        "directory": "findopen",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/findopen.png",
                        "found": false,
                        "date": "2021-01-06T21:24:44.000Z"
                    },
                    {
                        "product": "Foursquare",
                        "directory": "foursquare",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/foursquare.png",
                        "found": true,
                        "score": 94,
                        "type": "aggregator",
                        "date": "2021-01-06T21:24:51.000Z",
                        "link": "https://foursquare.com/v/kellys-art-shack/5d553f77e8791a0008842e43",
                        "name": "Kelly’s Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX 75069, United States",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Here",
                        "type": "directory",
                        "directory": "here",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/here.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Hotfrog",
                        "type": "directory",
                        "directory": "hotfrog",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/hotfrog.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Hubbiz",
                        "type": "directory",
                        "directory": "hubbiz",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/hubbiz.png",
                        "found": false,
                        "date": "2021-01-06T21:24:43.000Z"
                    },
                    {
                        "product": "Ibegin",
                        "directory": "ibegin",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/ibegin.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:44.000Z",
                        "link": "https://www.ibegin.com/directory/visit/17037905",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, Mckinney, Texas 75069",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Infobel",
                        "directory": "infobel",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/infobel.png",
                        "found": true,
                        "score": 59,
                        "type": "directory",
                        "date": "2021-01-06T21:24:43.000Z",
                        "link": "https://www.us-info.com/en/usa/kelly_s_art_shack/mckinney/USTX102328767-2149358891/businessdetails.aspx",
                        "name": "Kelly's Art Shack",
                        "address": "312 Cloyd St, 75069 McKinney, Texas",
                        "phone": "xIjh3b3+UefOQSaI5zdaQbBDIlsYdssNpJf2njXaJhY=",
                        "nap": {
                            "name": 82,
                            "address": 96,
                            "phone": 0
                        }
                    },
                    {
                        "product": "Infogroup",
                        "type": "aggregator",
                        "directory": "infogroup",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/infogroup.png",
                        "found": false,
                        "date": "2021-01-06T21:24:58.000Z"
                    },
                    {
                        "product": "Invalid",
                        "type": "directory",
                        "directory": "invalid",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/invalid.png",
                        "found": false,
                        "date": "2021-01-06T21:24:50.000Z"
                    },
                    {
                        "product": "Judysbook",
                        "directory": "judysbook",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/judysbook.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:43.000Z",
                        "link": "https://www.judysbook.com/Kellys-Art-Shack-Art-Studios-mckinney-tx-r39944456.htm",
                        "name": "Kelly’s Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
                        "phone": "2149358891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Localeze",
                        "directory": "localeze",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/localeze.png",
                        "found": true,
                        "score": 93,
                        "type": "aggregator",
                        "date": "2021-01-06T21:24:42.000Z",
                        "link": "https://www.neustarlocaleze.biz/directory/us/tx/mckinney/kellys-art-shack/906054103/",
                        "name": "Kelly's Art Shack",
                        "address": "312 Cloyd St, Mckinney, TX, 75069",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 96,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Localmint",
                        "type": "directory",
                        "directory": "localmint",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/localmint.png",
                        "found": false,
                        "date": "2021-01-06T21:24:44.000Z"
                    },
                    {
                        "product": "Localstack",
                        "directory": "localstack",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/localstack.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:43.000Z",
                        "link": "https://localstack.com/biz/kellys-art-shack-mckinney-tx/3568539",
                        "name": "Kellys Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX 75069",
                        "phone": "(214) 935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Merchantcircle",
                        "directory": "merchantcircle",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/merchantcircle.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:50.000Z",
                        "link": "https://www.merchantcircle.com/kelly-s-art-shack-mckinney-tx",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX, 75069",
                        "phone": "214-935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "N49",
                        "type": "directory",
                        "directory": "n49",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/n49.png",
                        "found": false,
                        "date": "2021-01-06T21:24:41.000Z"
                    },
                    {
                        "product": "Opendi",
                        "type": "directory",
                        "directory": "opendi",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/opendi.png",
                        "found": false,
                        "date": "2021-01-06T21:24:59.000Z"
                    },
                    {
                        "product": "Showmelocal",
                        "directory": "showmelocal",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/showmelocal.png",
                        "found": true,
                        "score": 94,
                        "type": "directory",
                        "date": "2021-01-06T21:24:50.000Z",
                        "link": "https://www.showmelocal.com/profile.aspx?bid=23095653",
                        "name": "Kelly's Art Shack",
                        "address": "312 East Cloyd Street, Mckinney, TX, 75069",
                        "phone": "(214)935-8891",
                        "nap": {
                            "name": 82,
                            "address": 100,
                            "phone": 100
                        }
                    },
                    {
                        "product": "Sitecards",
                        "type": "directory",
                        "directory": "sitecards",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/sitecards.png",
                        "found": false,
                        "date": "2021-01-06T21:24:50.000Z"
                    },
                    {
                        "product": "Superpages",
                        "type": "directory",
                        "directory": "superpages",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/superpages.png",
                        "found": false,
                        "date": "2021-01-06T21:24:48.000Z"
                    },
                    {
                        "product": "Tupalo",
                        "type": "directory",
                        "directory": "tupalo",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/tupalo.png",
                        "found": false,
                        "date": "2021-01-06T21:24:43.000Z"
                    },
                    {
                        "product": "Uscity",
                        "type": "directory",
                        "directory": "uscity",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/uscity.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Verizon411",
                        "type": "ftp",
                        "directory": "verizon411",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/verizon411.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Whereto",
                        "type": "directory",
                        "directory": "whereto",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/whereto.png",
                        "found": false,
                        "date": "2021-01-06T21:24:42.000Z"
                    },
                    {
                        "product": "Wherezit",
                        "type": "directory",
                        "directory": "wherezit",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/wherezit.png",
                        "found": false,
                        "date": "2021-01-06T21:24:41.000Z"
                    },
                    {
                        "product": "Yasabe",
                        "directory": "yasabe",
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/yasabe.png",
                        "found": true,
                        "score": 86,
                        "type": "directory",
                        "date": "2021-01-06T21:24:42.000Z",
                        "link": "https://www.dev.yasabe.com/en/mckinney-tx/d-1000000963797-kellys-art-shack.html",
                        "name": "Kellys Art Shack",
                        "address": "312 East Cloyd Street, McKinney, TX",
                        "phone": "(214)-935-8891",
                        "nap": {
                            "name": 82,
                            "address": 75,
                            "phone": 100
                        }
                    }
                ],
                "voice": [
                    {
                        "device": "google",
                        "name": "Google Assistant",
                        "score": 100,
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/google-home.png"
                    },
                    {
                        "device": "siri",
                        "name": "Apple Siri",
                        "score": 0,
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/Siri-logo.png"
                    },
                    {
                        "device": "bixby",
                        "name": "Samsung Bixby",
                        "score": 75,
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/Bixby.png"
                    },
                    {
                        "device": "alexa",
                        "name": "Amazon Alexa",
                        "score": 75,
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/amazon-alexa.png"
                    },
                    {
                        "device": "cortana",
                        "name": "Microsoft Cortana",
                        "score": 75,
                        "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cortana-logo.png"
                    }
                ]
            }
        },
        "products": []
    }
}

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
    }
}


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 /legacyinsightdata?client={clientid} 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": 123,
            "partner": 123456,
            "id": 3,
            "store_code": 0,
            "LA_score": 36,
            "brand_score": 0,
            "influence_score": 100,
            "listing_score": 80,
            "reputation_score": 0,
            "engagement_score": 0,
            "website_visits": 0,
            "phone_calls_clicks": 0,
            "phone_calls_tracked": 0,
            "directions": 0,
            "calls_directions": 0,
            "conv_rate": 0,
            "total_conversions": 0,
            "avg_sale_price": 0,
            "potential_revenue": 0,
            "investment": 0,
            "potential_roi": 0,
            "review_rating": 0,
            "photo_views": 28,
            "discovery_impressions": 6,
            "direct_impressions": 0,
            "chain_impressions": 0,
            "search_impressions_from_chain": 0,
            "listing_views": 6,
            "total_calls": 0,
            "first_time_caller": 0,
            "duration_seconds": 0,
            "active_location": 0,
            "cost_per_location": 0,
            "total_impressions": 6,
            "total_actions": 0,
            "cost_per_actions": 0,
            "createdAt": "2020-05-14T19:26:58.000Z",
            "recordedAt": "2020-05-07T12:00:00.000Z",
            "updatedAt": "2020-05-14T19:27:31.000Z"
        }
    ]
}


Voice Data

This endpoint provides information on voice enabled locations via the AdVoice product. All 3 query parameters are required. Unlike the other endpoints in our system, there are no conditionals that you can include in the request. The data returned is always an aggregate. You are free to set any range you wish and the endpoint will provide the totals for you.

API Endpoint

https://p.lssdev.com/legacyvoicedata?client={clientid}&startDate={startDate}&endDate={endDate}

Example Request

GET /legacyvoicedata?client={clientid}&startDate=2020-01-01&endDate=2020-07-01 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": {
        "users_total": 115,
        "sessions_total": 210,
        "requests_total": 726,
        "users": [
            {
                "count": 41,
                "assistant": "GoogleAssistant"
            },
            {
                "count": 74,
                "assistant": "Alexa"
            }
        ],
        "requests": [
            {
                "count": 41,
                "assistant": "GoogleAssistant"
            },
            {
                "count": 74,
                "assistant": "Alexa"
            }
        ]
    }
}


Review Data

This endpoint provides a large JSON object with aggregate statistics as well as a sample set of recent review objects. This endpoint is only available for locations with active orders.

API Endpoint

https://p.lssdev.com/legacyclients/{clientid}/reviews

Example Request

GET /legacyclients/3782992/reviews 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": {
        "reviews": 21,
        "score": {
            "total": 4.85,
            "months_1": 4.85,
            "months_6": 4.85
        },
        "recency": {
            "total": 0,
            "week_1": 0,
            "months_1": 0,
            "months_2": 0,
            "months_3": 0
        },
        "sentiment": {
            "positive": 75,
            "above_average": 0,
            "neutral": 0,
            "below_average": 1,
            "negative": 0
        },
        "sources": [
            {
                "name": "BrownBook",
                "score": 2,
                "reviews": 1,
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/brownbook.png"
            },
            {
                "name": "Cylex USA",
                "score": 0,
                "reviews": 0,
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/cylex.png"
            },
            {
                "name": "Google",
                "score": 5,
                "reviews": 17,
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/google.png"
            },
            {
                "name": "Judy's Book",
                "score": 0,
                "reviews": 0,
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/judysbook.png"
            },
            {
                "name": "ShowMeLocal",
                "score": 0,
                "reviews": 0,
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/showmelocal.png"
            },
            {
                "name": "Yelp",
                "score": 5,
                "reviews": 3,
                "logo": "https://s3.amazonaws.com/p.assets.lssdev.com/directory_images/yelp.png"
            }
        ],
        "data": [
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "google",
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
                "reviewer": "Alison Thornton",
                "sentiment": null,
                "score": 5,
                "comment": "I had an incredible experience at Kelly's Art Shack & Events! The venue was perfect for hosting birthday parties, and the karaoke added a fantastic touch of entertainment. The Arty Party was a blast, and I thoroughly enjoyed painting a lively Tuscan scene. Kelly's Art Shack & Events is definitely a downtown McKinney gem for art enthusiasts and party-goers alike!",
                "replied": true,
                "id": 33407619,
                "createdAt": "2023-07-12T05:47:07.000Z",
                "reviewKey": "AbFvOqlx3ckOFtjqB498fIWRyzY-ZtOLhRez8hkzFFG2UKCgv0vKhhLwah4HVopX5mfB4nZbJ0YU",
                "reviewedAt": "2023-06-02T17:07:50.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "google",
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
                "reviewer": "Paul Grossman",
                "sentiment": null,
                "score": 5,
                "comment": "Breathtaking art!!! A wonderful place to see, learn from, and grow.",
                "replied": true,
                "id": 33407620,
                "createdAt": "2023-07-12T05:47:07.000Z",
                "reviewKey": "AbFvOqkxwZH_GD9qMaCuVB4zGt2I5sXuRgi0_ok4nmkfASBHP-bLtEhuz7BvyNihW38XI5tSHns3",
                "reviewedAt": "2023-02-16T21:50:47.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "google",
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
                "reviewer": "Linda Nunn",
                "sentiment": null,
                "score": 5,
                "comment": "Kelly is an amazing artist . I have purchased many canvases from her. In addition , she hosts events and is very involved with McKinney life. She features fellow artists as well and promotes great local bands. It is a fun place to visit or book a birthday party or commission Kelly for a mural or canvas for your home.",
                "replied": true,
                "id": 33407616,
                "createdAt": "2023-07-12T05:47:07.000Z",
                "reviewKey": "AbFvOqn4jpaktJNV_A6i4LKWAt1MTuP8uZuzCm0nWmxWDPcCxjmaTP8ZctiJqkMyHHtGkeBHHXOrKw",
                "reviewedAt": "2022-09-13T11:09:29.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "google",
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
                "reviewer": "Letitia Sanchez",
                "sentiment": null,
                "score": 5,
                "comment": "Kelly is a wonderful, professional artist who is a dream to collaborate with. Her art gallery and event venue is a beautiful space.\n\nTonight, Kelly's Art Gallery was the location for Joyland's Speakeasy paint and sip party. Poppy's Wings served catfish with truffle mac & cheese and baked beans. Folks, GET YOU SOME OF EVERYTHING!!!! Run, don't walk.",
                "replied": true,
                "id": 33407632,
                "createdAt": "2023-07-12T05:47:07.000Z",
                "reviewKey": "AbFvOqlWgPK8K77bs21PrqgpOohRorsbnmX9z5eljUPLitkBtdluw3-UCqoUVaQLtAVfZvrFPkLF",
                "reviewedAt": "2022-08-14T04:55:28.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "google",
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
                "reviewer": "Joseph Ortiz",
                "sentiment": null,
                "score": 5,
                "comment": "",
                "replied": true,
                "id": 33407628,
                "createdAt": "2023-07-12T05:47:07.000Z",
                "reviewKey": "AbFvOqns8q_enfIwdmCMasU8OjeiyHAYZopnNUdB-wo9kUmHVC_2PfpduCvKAntwXiwv0T6oUM4YJA",
                "reviewedAt": "2022-08-03T16:46:36.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "brownbook",
                "url": "https://www.brownbook.net/business/49380379/kellys-art-shack-events",
                "reviewer": "Dr. Franklin Perry",
                "sentiment": null,
                "score": 2,
                "comment": "Did a great job on my commissioned artwork",
                "replied": false,
                "id": 38046,
                "createdAt": "2022-09-21T17:59:05.000Z",
                "reviewKey": "603793",
                "reviewedAt": "2022-05-03T19:18:52.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147837",
                "reviewer": "William Marcus",
                "sentiment": null,
                "score": 5,
                "comment": "The fitters came on time, worked quickly and cleanly. Care and operation of the air conditioner were also explained to us in a way that was easy to understand. Thanks a lot for Air Track. Gladly again.",
                "replied": false,
                "id": 21,
                "createdAt": "2022-06-21T21:47:58.000Z",
                "reviewKey": "CA147837",
                "reviewedAt": "2022-03-07T10:16:46.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147599",
                "reviewer": "Jay J. Jones",
                "sentiment": null,
                "score": 5,
                "comment": "Just had Air track Inc in to replace an old HVAC unit. Director Frank was outstanding! He’s honest, gives you his opinion yet respects your needs. Extremely kind and courteous with almost 40 years of experience, the work completed was outstanding. Definitely recommend them.",
                "replied": false,
                "id": 24,
                "createdAt": "2022-06-21T21:47:58.000Z",
                "reviewKey": "CA147599",
                "reviewedAt": "2022-01-18T12:16:57.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "google",
                "url": "https://search.google.com/local/reviews?placeid=ChIJBQbtuH8TTIYRougs11iNdMw",
                "reviewer": "latasha whalen",
                "sentiment": null,
                "score": 5,
                "comment": "",
                "replied": true,
                "id": 33407622,
                "createdAt": "2023-07-12T05:47:07.000Z",
                "reviewKey": "AbFvOqmp3Rwzi0ReMLaVJWUe163LOHL6ke9xgJOZD_vHMqn-q74IEl7P9qVYLd1fiPvBgCs8a-wv",
                "reviewedAt": "2022-01-09T00:35:09.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147474",
                "reviewer": "Kyle Butler",
                "sentiment": null,
                "score": 5,
                "comment": "Excellent Service; after accepting a detailed quote from Frank, our replacement combo boiler was installed 3 days later. They demonstrated how to manage the boiler &amp; wireless controller before removing the old boiler &amp; tidying up before leaving.. I would definitely recommend Air Track Inc.",
                "replied": false,
                "id": 37,
                "createdAt": "2022-06-21T21:48:02.000Z",
                "reviewKey": "CA147474",
                "reviewedAt": "2021-12-29T18:18:37.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147452",
                "reviewer": "Ivan Cohen",
                "sentiment": null,
                "score": 5,
                "comment": "Fantastic throughout. Very professional, kept us well informed, worked well with the other people working on our basement and took a huge amount of pride in their work. Very highly recommended.",
                "replied": false,
                "id": 41,
                "createdAt": "2022-06-21T21:48:03.000Z",
                "reviewKey": "CA147452",
                "reviewedAt": "2021-12-24T11:38:14.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147355",
                "reviewer": "Christopher Fonville",
                "sentiment": null,
                "score": 5,
                "comment": "Excellent service..My 5 month old boiler stopped working. Frank turned up on time , resolved the problem really quickly,it wasnt the boiler but one of two options, both of he pointed out to me and were a quick fix . Thank you for your help and time .",
                "replied": false,
                "id": 39,
                "createdAt": "2022-06-21T21:48:02.000Z",
                "reviewKey": "CA147355",
                "reviewedAt": "2021-12-01T13:37:21.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147345",
                "reviewer": "Kristen Spearman",
                "sentiment": null,
                "score": 5,
                "comment": "I recommend Air Track Inc to everyone. They fulfilled the agreement with excellence of professionalism. Excellent professional!  They handle the equipment very carefully to protect the same. Attentive, punctual, clean service. I confirm the other positive evaluations of this professional. Also for the fast service for getting it done. We were so pleased with their service and we used them again.",
                "replied": false,
                "id": 27,
                "createdAt": "2022-06-21T21:47:59.000Z",
                "reviewKey": "CA147345",
                "reviewedAt": "2021-11-30T10:42:22.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147192",
                "reviewer": "Maverick Erickson",
                "sentiment": null,
                "score": 5,
                "comment": "Customer service is still very important here - friendly, competent and punctual. Thank you Air Track.",
                "replied": false,
                "id": 1,
                "createdAt": "2022-06-21T21:47:55.000Z",
                "reviewKey": "CA147192",
                "reviewedAt": "2021-11-08T10:53:58.000Z"
            },
            {
                "client": 3782992,
                "partner": 45803,
                "batch": null,
                "provider": "cylex",
                "url": "https://www.cylex-canada.ca/company/air-track-inc-23498654.html#rev147122",
                "reviewer": "Roman Prince",
                "sentiment": null,
                "score": 5,
                "comment": "Air Track team work was good.Great expertise - especially when it comes to air conditioning systems from Our Company. Fair in price. You are in good hands there!. Thanks to Air Track INC.",
                "replied": false,
                "id": 5,
                "createdAt": "2022-06-21T21:47:55.000Z",
                "reviewKey": "CA147122",
                "reviewedAt": "2021-10-26T12:30:42.000Z"
            }
        ],
        "summaries": [
            {
                "client": 3782992,
                "partner": 45803,
                "directory": "brownbook",
                "rating": 2,
                "id": 98,
                "createdAt": "2022-07-26T00:28:51.000Z",
                "errorAt": null,
                "updatedAt": "2023-12-15T07:03:08.000Z",
                "reviews": 1,
                "maxRating": 2
            },
            {
                "client": 3782992,
                "partner": 45803,
                "directory": "cylex",
                "rating": 0,
                "id": 6,
                "createdAt": "2022-07-25T22:26:56.000Z",
                "errorAt": null,
                "updatedAt": "2023-12-15T07:03:39.000Z",
                "reviews": 0,
                "maxRating": 0
            },
            {
                "client": 3782992,
                "partner": 45803,
                "directory": "google",
                "rating": 5,
                "id": 25028,
                "createdAt": "2022-09-06T17:19:06.000Z",
                "errorAt": null,
                "updatedAt": "2023-12-15T07:02:42.000Z",
                "reviews": 17,
                "maxRating": 5
            },
            {
                "client": 3782992,
                "partner": 45803,
                "directory": "judysbook",
                "rating": 0,
                "id": 83,
                "createdAt": "2022-07-26T00:25:35.000Z",
                "errorAt": null,
                "updatedAt": "2023-12-15T06:58:02.000Z",
                "reviews": 0,
                "maxRating": 0
            },
            {
                "client": 3782992,
                "partner": 45803,
                "directory": "showmelocal",
                "rating": 0,
                "id": 95,
                "createdAt": "2022-07-26T00:28:51.000Z",
                "errorAt": null,
                "updatedAt": "2023-12-15T07:03:13.000Z",
                "reviews": 0,
                "maxRating": 0
            },
            {
                "client": 3782992,
                "partner": 45803,
                "directory": "yelp",
                "rating": 5,
                "id": 24709,
                "createdAt": "2022-09-06T17:18:29.000Z",
                "errorAt": null,
                "updatedAt": "2023-12-15T07:01:46.000Z",
                "reviews": 3,
                "maxRating": 5
            }
        ]
    }
}


Keyword Data

This endpoint provides reporting on keyword organic rankings as well as a map grid chart centered around the business. Aside from the current "grid" and ranking data, there are histories for both. The "grid_history" property retains a list of all the data refreshed every Friday and does not the most recent set of data. The organic ranking data however does include the current ranking. The rank_history property is ordered from the most recent to oldest.

API Endpoint

https://p.lssdev.com/legacykeywords/{clientid}

Example Request

GET /legacykeywords/3782992 HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json



{
    "status": 200,
    "success": true,
    "error": null,
    "data": [
    {
        "processing": false,
        "keyword": "art dealer",
        "grid_id": 5979,
        "grid": [
            {
                "LAT": 33.4145,
                "LON": -96.3518,
                "rank": 0,
                "point": "-3,-3"
            },
            {
                "LAT": 33.4145,
                "LON": -96.4388,
                "rank": 7,
                "point": "-3,-2"
            },
            {
                "LAT": 33.4145,
                "LON": -96.5258,
                "rank": 0,
                "point": "-3,-1"
            }
         
        ],
        "LAT": 33.197,
        "LON": -96.6128,
        "thedate": "2024-08-01 18:51:46",
        "grid_distance": 5,
        "history": [
            {
                "grid": [
                    {
                        "LAT": 33.4145,
                        "LON": -96.3518,
                        "rank": 0,
                        "point": "-3,-3"
                    },
                    {
                        "LAT": 33.4145,
                        "LON": -96.4388,
                        "rank": 0,
                        "point": "-3,-2"
                    },
                    {
                        "LAT": 33.4145,
                        "LON": -96.5258,
                        "rank": 0,
                        "point": "-3,-1"
                    },
                  
                ],
                "grid_id": 5970,
                "date": "2024-08-01 18:51:41",
                "rank": 7
          }
        ]
     }
   ]
}

API Endpoint to Start Tracking Keyword

You can add new keywords and location to start tracking. The keywords to not have to match the keywords of your client data. The location can be different as well. For example, your business may be in Dallas Texas but you may wish to start tracking keyword rankings for the neighboring city of McKinney Texas. 

https://p.lssdev.com/legacykeywords/{clientid}

Example Request

POST /legacykeywords/3782992 HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json

{ keyword }

Example Response

{
    "status": 200,
    "success": true,
    "error": null,
    "data": {
    "status": 200,
    "success": true,
    "error": null,
    "data": [
        {
            "processing": false,
            "keyword": "art dealer",
            "grid_id": 5979,
            "grid": [
                {
                    "LAT": 33.4145,
                    "LON": -96.3518,
                    "rank": 0,
                    "point": "-3,-3"
                },
                {
                    "LAT": 33.4145,
                    "LON": -96.4388,
                    "rank": 7,
                    "point": "-3,-2"
                },
                {
                    "LAT": 33.4145,
                    "LON": -96.5258,
                    "rank": 0,
                    "point": "-3,-1"
                }
             
            ],
            "LAT": 33.197,
            "LON": -96.6128,
            "thedate": "2024-08-01 18:51:46",
            "grid_distance": 5,
            "history": [
                {
                    "grid": [
                        {
                            "LAT": 33.4145,
                            "LON": -96.3518,
                            "rank": 0,
                            "point": "-3,-3"
                        },
                        {
                            "LAT": 33.4145,
                            "LON": -96.4388,
                            "rank": 0,
                            "point": "-3,-2"
                        },
                        {
                            "LAT": 33.4145,
                            "LON": -96.5258,
                            "rank": 0,
                            "point": "-3,-1"
                        },
                     
                    ],
                    "grid_id": 5970,
                    "date": "2024-08-01 18:51:41",
                    "ranking": null
                },
           
    ]
}
}

API Endpoint to Delete Single Keyword

This will delete a single keyword from the list of keyword campaigns from the 

https://p.lssdev.com/legacykeywords/{clientid}/{keyword}

Example Request

DELETE /legacykeywords/3782992/grooming 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": true
}


API Endpoint to Reset All Keywords

If you wish to stop all the tracking campaigns, you can call this reset endpoint which will re-allocate the number any keyword campaigns you have per your location. 

https://p.lssdev.com/legacykeywords/{clientid}

Example Request

DELETE /legacykeywords/3782992 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": true
}
Retrieved from "http://wiki.advicelocal.com/index.php?title=Reports&oldid=490"