Version 1 of the XAmplifier API is structured around REST, HTTP, and JSON. API endpoint URLs are organized around resources, such as events or surveys. It uses HTTP methods for indicating the action to take on a resource, and HTTP status codes for expressing error states. Resources are represented in JSON following a conventional scheme.
\nThe XAmplifier API set includes resources to post events and also to get event-related data from the XAmplifier system. In order to use the API you will need to obtain your unique API authorization token from the XAmplifier Insights system. After logging in you can retrieve your token by navigating to the API Credentials screen under the Admin menu item.
\nWe will be continually adding to our list of supported resources as we continue building out the API. Here are the current API resources available:
\nEvents
\nCreate an event - Post an event to the XAmplifier system. Requires a location ID and a survey ID which can be retrieved with other API calls (as described below). Parameters can be used to request survey and/or review invites be sent immediately or on a predefined schedule.
\nRetrieve indiviual event - Get the details of an event using the event ID.
\nRetrieve all events - Get a group of event IDs with corresponding event data elements based on a date range and location and survey parameters.
\nLocations
\nPersonnel
\nSurveys
\nRetrieve survey results - Get XAmplifier survey results for a specfiic event using the event ID.
\nRetrieve surveys - Get a list of all valid surveys available. Returned survey IDs can be used in Post event API call.
\nReviews
\nRetrieve all review data - Get review data for specific locations or all locations.
\nRetrieve aggegated review data - Get specific aggragated review data for a particular month.
\nXAmplifier Survey ID (string) - Identifies the Survey corresponding to the type of patient event (provided by XA client ops manager or from the Retrieve Surveys resource) *Required Field
\n"},{"key":"Location","value":"5d83e8b203c9192bd6777072","type":"text","description":"XAmplifier Location ID (string) - Identifies the clinic location (provided by XA client ops manager or from the Retrieve All Locations resource) *Required Field
\n"},{"key":"ClientContactID","value":"423656","type":"text","description":"Client Contact ID - Unique
\ncontact identifier from client's CRM or EMR system *Required Field
\n"},{"key":"EventDate","value":"04/14/2024","description":"Date of the event *Required Field
\n","type":"text"},{"key":"CellPhone","value":"5552221212","type":"text","description":"Patient's mobile number *Cellphone or Email is required
\n"},{"key":"Email","value":"test@gmail.com","type":"text","description":"Patient's email address *Cellphone or Email is required
\n"},{"key":"EmailStatus","value":"1","type":"text","description":"Opt-in flag for EMAIL: 1 = Yes, 0 = No. *Required Field
\n"},{"key":"SMSStatus","value":"1","type":"text","description":"Opt-in flag for SMS: 1 = Yes, 0 = No. *Required Field
\n"},{"key":"EmailSurveyInvite","value":"0","type":"text","description":"Schedule for emailed survey invite. 0 = Do not send, 1 = Immediate, 2 = pre-defined schedule. *Required Field
\n"},{"key":"EmailReviewInvite","value":"0","type":"text","description":"Schedule for emailed review invite. 0 = Do not send, 1 = Immediate, 2 = pre-defined schedule. *Required Field
\n"},{"key":"SmsSurveyInvite","value":"0","type":"text","description":"Schedule for SMS survey invite. 0 = Do not send, 1 = Immediate, 2 = pre-defined schedule. *Required Field
\n"},{"key":"SmsReviewInvite","value":"1","type":"text","description":"Schedule for SMS review invite. 0 = Do not send, 1 = Immediate, 2 = pre-defined schedule. *Required Field
\n"},{"key":"FirstName","value":"Tony","type":"text","description":"Patient's first name
\n"},{"key":"LastName","value":"Stark","type":"text","description":"Patient's last name
\n"},{"key":"Address1","value":"1234 Ava Shore Kuphall","type":"text","description":"Patient's address line 1
\n"},{"key":"Address2","value":"Apartment 4","type":"text","description":"Patient's address line 2
\n","disabled":true},{"key":"Language","value":" 1","type":"text","description":"Language code: English=1, Spanish=2
\n"},{"key":"City","value":"PORT DAPHNE","type":"text","description":"Patient's city
\n"},{"key":"State","value":"MA","type":"text","description":"Patient's state
\n"},{"key":"Zip","value":"62586","type":"text","description":"Patient's zip code
\n"},{"key":"HomePhone","value":"5554732525","type":"text","description":"Patient's home phone number
\n"},{"key":"WorkPhone","value":"5554732525","type":"text","description":"Patient's work phone number
\n"},{"key":"BirthDate","value":"08/03/1983","type":"text","description":"Patient's date of birth
\n"},{"key":"Gender","value":"Male","type":"text","description":"Patient's gender: M=Male, F=Female, O=Other
\n"},{"key":"Ethnicity","value":"White","type":"text","description":"Patient's ethnicity
\n"},{"key":"InquiryDate","value":"01/07/2024","type":"text","description":"Date of patient's first inquiry about client services
\n"},{"key":"ScheduledBy","value":"Pepper Potts","type":"text","description":"Person who scheduled the consultation
\n"},{"key":"ConsultServiceType","value":"New Patient","type":"text"},{"key":"ConsultDate","value":"07/19/2023","type":"text","description":"Date of the consultation
\n","disabled":true},{"key":"ConsultantName","value":"Mary Jones","type":"text"},{"key":"ConsultCancellationDate","value":"","type":"text","disabled":true},{"key":"ServiceType","value":"Vein Ablation","type":"text"},{"key":"ServiceDate","value":"08/22/2023","type":"text","description":"Date of the service provided
\n","disabled":true},{"key":"ServiceProviderName","value":" ","type":"text"},{"key":"ServiceRevenue","value":"","type":"text"},{"key":"LifetimeRevenue","value":"","type":"text"},{"key":"MaritalStatus","value":"Married","type":"text"},{"key":"PrimaryInsurance","value":"BCBS","type":"text"},{"key":"SecondaryInsurance","value":"","type":"text"},{"key":"SMSDate","value":"","type":"text","description":"Date that the SMS permission was set
\n"},{"key":"EmailDate","value":"","type":"text","description":"Date that the email permission was set
\n"},{"key":"LeadSource","value":"advertising","type":"text","description":"Source of the lead (e.g.advertising)
\n"},{"key":"Account Name","value":"Account","description":"Name of the account related to the event
\n","type":"text"},{"key":"UserVarChar1","value":"char(255)","description":"Custom user defined char data field
\n","type":"text","disabled":true},{"key":"UserVarChar2","value":"char(255)","description":"Custom user defined char data field
\n","type":"text","disabled":true},{"key":"UserVarChar3","value":"char(255)","description":"Custom user defined char data field
\n","type":"text","disabled":true},{"key":"UserVarChar4","value":"char(255)","description":"Custom user defined char data field
\n","type":"text","disabled":true},{"key":"UserDate1","value":"mm/dd/yyyy","description":"Custom user defined date data field
\n","type":"text","disabled":true},{"key":"UserDate2","value":"mm/dd/yyyy","description":"Custom user defined date data field
\n","type":"text","disabled":true},{"key":"UserDate3","value":"mm/dd/yyyy","description":"Custom user defined date data field
\n","type":"text","disabled":true},{"key":"UserDate4","value":"mm/dd/yyyy","description":"Custom user defined date data field
\n","type":"text","disabled":true},{"key":"UserReal1","value":"real","description":"Custom user defined real number data field
\n","type":"text","disabled":true},{"key":"UserReal2","value":"real","description":"Custom user defined real number data field
\n","type":"text","disabled":true},{"key":"UserReal3","value":"real","description":"Custom user defined real number data field
\n","type":"text","disabled":true},{"key":"UserReal4","value":"real","description":"Custom user defined real number data field
\n","type":"text","disabled":true},{"key":"UserInt1","value":"int","description":"Custom user defined int number data field
\n","type":"text","disabled":true},{"key":"UserInt2","value":"int","description":"Custom user defined int number data field
\n","type":"text","disabled":true},{"key":"UserInt3","value":"int","description":"Custom user defined int number data field
\n","type":"text","disabled":true},{"key":"UserInt4","value":"int","description":"Custom user defined int number data field
\n","type":"text","disabled":true}]},"url":"https://api.xamplifier.com/api/v1/event","description":"Post a dataset to the XAmplifier event collection in order to create an event record.
\n","urlObject":{"protocol":"https","path":["api","v1","event"],"host":["api","xamplifier","com"],"query":[],"variable":[]}},"response":[{"id":"c1edcad1-4b70-4d4c-9b35-1bb0a8b68f96","name":"Create an event","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"SurveyType","value":"5d83e86003c9191ec93cd983","type":"text","description":"xAmplifier Survey ID (string) - Identifies the Survey corresponding to the type of patient event (provided by XA client ops manager or from the Retrieve Surveys resource) ***Required Field**"},{"key":"Location","value":"5d83e8b203c9192bd6777072","type":"text","description":"xAmplifier Location ID (string) - Identifies the clinic location (provided by XA client ops manager or from the Retrieve All Locations resource) ***Required Field**"},{"key":"ClientContactID","value":"Mervel987","type":"text","description":"Client Contact ID - Unique contact identifier from client's CRM or EMR system ***Required Field**"},{"key":"EventDate","value":"10/12/2023","description":"Date of the event ***Required Field**","type":"text"},{"key":"CellPhone","value":"8888888999","type":"text","description":"Patient's mobile number ***Cellphone or Email is required**"},{"key":"Email","value":"anthonystark2345@testmail.com","type":"text","description":"Patient's email address ***Cellphone or Email is required**"},{"key":"EmailStatus","value":"1","type":"text","description":"Opt-in flag for EMAIL: 1 = yes, 0 = No. ***Required Field**"},{"key":"SMSStatus","value":"1","type":"text","description":"Opt-in flag for SMS: 1 = yes, 0 = No. ***Required Field**"},{"key":"EmailSurveyInvite","value":"1","type":"text","description":"Should this posting trigger a survey invite via email immediately? 0=no, 1=yes. Set to 2 for regular processing. ***Required Field**"},{"key":"EmailReviewInvite","value":"1","type":"text","description":"Should this posting trigger a review invite via email immediately? 0=no, 1=yes. Set to 2 for regular processing. ***Required Field**"},{"key":"SmsSurveyInvite","value":"1","type":"text","description":"Should this posting trigger a survey invite via SMS immediately? 0=no, 1=yes. Set to 2 for regular processing. ***Required Field**"},{"key":"SmsReviewInvite","value":"1","type":"text","description":"Should this posting trigger a review invite via SMS immediately? 0=no, 1=yes. Set to 2 for regular processing. ***Required Field**"},{"key":"FirstName","value":"Anthony","type":"text","description":"Patient's first name"},{"key":"LastName","value":"Stark","type":"text","description":"Patient's last name"},{"key":"Address1","value":"10880 Malibu Point","type":"text","description":"Patient's primary address"},{"key":"Address2","value":"Apartment 401","type":"text","description":"Patient's secondary address","disabled":true},{"key":"Language","value":" 1","type":"text","description":"Language code: English=1, Spanish=2"},{"key":"City","value":"Malibu","type":"text","description":"Patient's city"},{"key":"State","value":"CA","type":"text","description":"Patient's state"},{"key":"Zip","value":"90265","type":"text","description":"Patient's zip code"},{"key":"HomePhone","value":"9999999999","type":"text","description":"Patient's home phone number"},{"key":"WorkPhone","value":"8888888888","type":"text","description":"Patient's work phone number"},{"key":"BirthDate","value":"05/29/1970","type":"text","description":"Patient's date of birth"},{"key":"Gender","value":"Male","type":"text","description":"Patient's gender M=Male, F=Female, O=Other"},{"key":"Ethnicity","value":"White","type":"text","description":"Patient's ethnicity"},{"key":"InquiryDate","value":"09/18/2023","type":"text","description":"Date of patient's first inquiry about client services","disabled":true},{"key":"ScheduledBy","value":"Pepper Potts","type":"text","description":"Person who scheduled the consultation"},{"key":"ConsultServiceType","value":"New Patient","type":"text"},{"key":"ConsultDate","value":"07/19/2023","type":"text","description":"Date of the event","disabled":true},{"key":"ConsultantName","value":"Mary Jones","type":"text"},{"key":"ConsultCancellationDate","value":"","type":"text","disabled":true},{"key":"ServiceType","value":"Vein Ablation","type":"text"},{"key":"ServiceDate","value":"08/22/2023","type":"text","description":"Date of the event","disabled":true},{"key":"ServiceProviderName","value":"","type":"text"},{"key":"ServiceRevenue","value":"","type":"text"},{"key":"LifetimeRevenue","value":"","type":"text"},{"key":"MaritalStatus","value":"Married","type":"text"},{"key":"PrimaryInsurance","value":"BCBS","type":"text"},{"key":"SecondaryInsurance","value":"","type":"text"},{"key":"SMSDate","value":"","type":"text","description":"Date that the SMS flag was set"},{"key":"EmailDate","value":"","type":"text","description":"Date that the emai flag was set"},{"key":"LeadSource","value":"advertising","type":"text","description":"Source of the lead (e.g.advertising)"},{"key":"Account Name","value":"Account","description":"Name of the account related to the event","type":"text"},{"key":"UserVarChar1","value":"char(255)","description":"Custom user defined char data field","type":"text","disabled":true},{"key":"UserVarChar2","value":"char(255)","description":"Custom user defined char data field","type":"text","disabled":true},{"key":"UserVarChar3","value":"char(255)","description":"Custom user defined char data field","type":"text","disabled":true},{"key":"UserVarChar4","value":"char(255)","description":"Custom user defined char data field","type":"text","disabled":true},{"key":"UserDate1","value":"mm/dd/yyyy","description":"Custom user defined date data field","type":"text","disabled":true},{"key":"UserDate2","value":"mm/dd/yyyy","description":"Custom user defined date data field","type":"text","disabled":true},{"key":"UserDate3","value":"mm/dd/yyyy","description":"Custom user defined date data field","type":"text","disabled":true},{"key":"UserDate4","value":"mm/dd/yyyy","description":"Custom user defined date data field","type":"text","disabled":true},{"key":"UserReal1","value":"real","description":"Custom user defined real number data field","type":"text","disabled":true},{"key":"UserReal2","value":"real","description":"Custom user defined real number data field","type":"text","disabled":true},{"key":"UserReal3","value":"real","description":"Custom user defined real number data field","type":"text","disabled":true},{"key":"UserReal4","value":"real","description":"Custom user defined real number data field","type":"text","disabled":true},{"key":"UserInt1","value":"int","description":"Custom user defined int number data field","type":"text","disabled":true},{"key":"UserInt2","value":"int","description":"Custom user defined int number data field","type":"text","disabled":true},{"key":"UserInt3","value":"int","description":"Custom user defined int number data field","type":"text","disabled":true},{"key":"UserInt4","value":"int","description":"Custom user defined int number data field","type":"text","disabled":true}]},"url":"https://api.xamplifier.com/api/v1/event"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Oct 2023 19:11:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"eventId\": \"652844e15b8d1b7a72762c1a\"\n },\n \"message\": \"Event created\"\n}"}],"_postman_id":"9c384d3e-f361-4afd-8952-a9f24f04f82f"},{"name":"Retrieve individual event","id":"e49c9368-9386-4266-83f7-11aaa8c14714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve data fields related to a specific event in XAmplifier. The input parameter is the XAmplifier eventID.
\n","urlObject":{"protocol":"https","path":["api","v1","event","6581df3c9792f057003ce804"],"host":["api","xamplifier","com"],"query":[{"description":{"content":"XAmplifier EventID that corresponds to the desired event *Required field
\n","type":"text/plain"},"key":"eventID","value":"666b6f40ea2544011d1c6416"}],"variable":[]}},"response":[{"id":"e284a4fd-b50c-403b-8bdc-3b4c40fb27ee","name":"Retrieve individual event","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"","value":"","type":"text","disabled":true}]},"url":"https://api.xamplifier.com/api/v1/event/652844e15b8d1b7a72762c1a"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Oct 2023 19:12:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"firstName\": \"Anthony\",\n \"lastName\": \"Stark\",\n \"email\": \"anthonystark2345@testmail.com\",\n \"cellPhone\": \"8888888999\",\n \"endPointName\": \"Chicago - IL\",\n \"personnelName\": \"\",\n \"productName\": \"Vein Ablation\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"eventDate\": \"2023-10-12\",\n \"surveyResponseStatus\": \"Incomplete\",\n \"bounceStatus\": \"invalid\"\n },\n \"message\": \"Event data\"\n}"}],"_postman_id":"e49c9368-9386-4266-83f7-11aaa8c14714"},{"name":"Retrieve all events","id":"e0d8d4e5-bd0e-4c12-ae31-f5b77f8f7d9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint returns event data elements for each event included in the selection criteria. The criteria include a date range for the event date, location or survey parameters.
\n","urlObject":{"protocol":"https","path":["api","v1","events"],"host":["api","xamplifier","com"],"query":[{"description":{"content":"Earliest event date
\n","type":"text/plain"},"key":"dateFrom","value":"12/01/2023"},{"description":{"content":"Latest event date
\n","type":"text/plain"},"key":"dateTo","value":"12/31/2023"},{"disabled":true,"description":{"content":"Keyword in the event data
\n","type":"text/plain"},"key":"keyword","value":"kkropp@xamplifier.com"},{"description":{"content":"XAmplifier ID for a specific survey. Use the Retrieve Surveys resource.
\n","type":"text/plain"},"key":"surveyId","value":"5d83e86003c9191ec93cd983"},{"disabled":true,"description":{"content":"XAmplifier ID for a specific locatoin. Use the Retrieve Locations resource.
\n","type":"text/plain"},"key":"endpointId","value":"63e1132e3142e20dc00c1852"},{"disabled":true,"description":{"content":"Number of events per page of results
\n","type":"text/plain"},"key":"pageSize","value":"4"},{"disabled":true,"description":{"content":"Number of pages returned
\n","type":"text/plain"},"key":"pageNumber","value":"2"}],"variable":[]}},"response":[{"id":"3f30a381-3256-424a-912e-423a4b886d2c","name":"Retrieve all events","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xamplifier.com/api/v1/events?dateFrom=12/01/2023&dateTo=12/31/2023&surveyId=5d83e86003c9191ec93cd983","protocol":"https","host":["api","xamplifier","com"],"path":["api","v1","events"],"query":[{"key":"dateFrom","value":"12/01/2023","description":"Earliest event date"},{"key":"dateTo","value":"12/31/2023","description":"Latest event date"},{"key":"keyword","value":"kkropp@xamplifier.com","description":"Keyword in the event data","disabled":true},{"key":"surveyId","value":"5d83e86003c9191ec93cd983","description":"XAmplifier ID for a specific survey. Use the Retrieve Surveys resource."},{"key":"endpointId","value":"63e1132e3142e20dc00c1852","description":"XAmplifier ID for a specific locatoin. Use the Retrieve Locations resource.","disabled":true},{"key":"pageSize","value":"4","description":"Number of events per page of results","disabled":true},{"key":"pageNumber","value":"2","description":"Number of pages returned","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Jan 2024 17:50:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=c7DrAD5ZZbJIQph05exEr6mzqHoWOq0FlB4Z02z0; expires=Wed, 03-Jan-2024 19:50:44 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"current_page\": 1,\n \"data\": {\n \"0\": {\n \"id\": \"6581dcdf3b995513a65c9fff\",\n \"firstName\": \"Kathleen\",\n \"lastName\": \"Test\",\n \"email\": \"kkropp@xamplifier.com\",\n \"cellPhone\": \"8476871241\",\n \"endPointName\": \"Chicago - IL\",\n \"endPointId\": \"5d83e8b203c9192bd6777072\",\n \"personnelName\": \"\",\n \"productName\": \"Unassigned\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"surveyId\": \"5d83e86003c9191ec93cd983\",\n \"eventDate\": \"2023-12-18\",\n \"surveyResponseStatus\": \"Incomplete\",\n \"bounceStatus\": \"valid\"\n },\n \"1\": {\n \"id\": \"6581df3c9792f057003ce803\",\n \"firstName\": \"Kathleen\",\n \"lastName\": \"Test\",\n \"email\": \"kkropp@xamplifier.com\",\n \"cellPhone\": \"8476871241\",\n \"endPointName\": \"Chicago - IL\",\n \"endPointId\": \"5d83e8b203c9192bd6777072\",\n \"personnelName\": \"\",\n \"productName\": \"Unassigned\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"surveyId\": \"5d83e86003c9191ec93cd983\",\n \"eventDate\": \"2023-12-18\",\n \"surveyResponseStatus\": \"Incomplete\",\n \"bounceStatus\": \"valid\"\n },\n \"2\": {\n \"id\": \"6581e0136fbddd064b0bb6cb\",\n \"firstName\": \"Kathleen\",\n \"lastName\": \"Test\",\n \"email\": \"aflessas@xamplfier.com\",\n \"cellPhone\": \"8476871241\",\n \"endPointName\": \"Chicago - IL\",\n \"endPointId\": \"5d83e8b203c9192bd6777072\",\n \"personnelName\": \"\",\n \"productName\": \"Unassigned\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"surveyId\": \"5d83e86003c9191ec93cd983\",\n \"eventDate\": \"2023-12-17\",\n \"surveyResponseStatus\": \"Complete\",\n \"bounceStatus\": \"invalid\"\n },\n \"3\": {\n \"id\": \"6581e31d37341753c31f0f49\",\n \"firstName\": \"Kathleen\",\n \"lastName\": \"Test\",\n \"email\": \"kkropp@xamplfier.com\",\n \"cellPhone\": \"8476871241\",\n \"endPointName\": \"Chicago - IL\",\n \"endPointId\": \"5d83e8b203c9192bd6777072\",\n \"personnelName\": \"\",\n \"productName\": \"Unassigned\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"surveyId\": \"5d83e86003c9191ec93cd983\",\n \"eventDate\": \"2023-12-17\",\n \"surveyResponseStatus\": \"Complete\",\n \"bounceStatus\": \"invalid\"\n },\n \"4\": {\n \"id\": \"6581e3a1a68f0726ac671f60\",\n \"firstName\": \"Tester 1\",\n \"lastName\": \"Tester 1\",\n \"email\": \"Kkropp@venatorpm.com\",\n \"cellPhone\": \"8476871241\",\n \"endPointName\": \"Chicago - IL\",\n \"endPointId\": \"5d83e8b203c9192bd6777072\",\n \"personnelName\": \"\",\n \"productName\": \"Unassigned\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"surveyId\": \"5d83e86003c9191ec93cd983\",\n \"eventDate\": \"2023-12-18\",\n \"surveyResponseStatus\": \"Complete\",\n \"bounceStatus\": \"valid\"\n },\n \"5\": {\n \"id\": \"6581e3bf8bc1655e945f643b\",\n \"firstName\": \"Tester 2\",\n \"lastName\": \"Tester 2\",\n \"email\": \"Kkropp@hotmail.com\",\n \"cellPhone\": \"8476871241\",\n \"endPointName\": \"Chicago - IL\",\n \"endPointId\": \"5d83e8b203c9192bd6777072\",\n \"personnelName\": \"\",\n \"productName\": \"Unassigned\",\n \"surveyName\": \"Demo Client - Post-Service - Survey\",\n \"surveyId\": \"5d83e86003c9191ec93cd983\",\n \"eventDate\": \"2023-12-18\",\n \"surveyResponseStatus\": \"Complete\",\n \"bounceStatus\": \"valid\"\n },\n \"npsScore\": 0,\n \"finalScore\": 0,\n \"dateComplete\": \"2023-12-19\",\n \"surveyResponseId\": \"6581e6b8f9d8064cc80e8794\"\n },\n \"first_page_url\": \"http://api.xamplifier.com/api/v1/events?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://api.xamplifier.com/api/v1/events?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"pagination.previous\",\n \"active\": false\n },\n {\n \"url\": \"http://api.xamplifier.com/api/v1/events?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"pagination.next\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"http://api.xamplifier.com/api/v1/events\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 6,\n \"total\": 6,\n \"success\": true,\n \"message\": \"Events data\"\n}"}],"_postman_id":"e0d8d4e5-bd0e-4c12-ae31-f5b77f8f7d9f"}],"id":"0608816e-a0c4-4f28-9fb2-8f9628dda35f","description":"The Events Resource is used to post event data into the XAmplifier database for further processing or to retrieve event data. Events include interactions with guests such as phone calls or attended appointments. A posted event can trigger immediate survey request emails and/or texts, immediate review request emails and/or texts, a pre-defined touchpoint journey, or no additional action. For an event to go into normal pre-defined touchpoint processing, all review and survey invite flags should be set to 2. Then the data posted will be processed according to your pre-defined schedule.
\n","_postman_id":"0608816e-a0c4-4f28-9fb2-8f9628dda35f"},{"name":"Locations","item":[{"name":"Retrieve all locations","id":"6920a2b0-0952-4ae4-bfb4-a3f7dc9c5117","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get a list of the valid XAmplifier location IDs that correspond to your locations within the XAmplifier system. The XAmplifier location IDs are required to use the 'Create an event' endpoint. Your API authorization token is used and all valid locations are returned. The Output includes the Location ID, Location Name, and the Client Location data fields.
\n","urlObject":{"protocol":"https","path":["api","v1","locations"],"host":["api","xamplifier","com"],"query":[],"variable":[]}},"response":[{"id":"73984994-ba97-4c50-a13d-55e83619c8a8","name":"Retrieve all locations","originalRequest":{"method":"GET","header":[],"url":"https://api.xamplifier.com/api/v1/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Jun 2024 02:27:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=EOGigNDtu6aGa0a7ZHh5Bkkl3k1OxNs1lx1rEdqO; expires=Thu, 13-Jun-2024 04:27:39 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"_id\": \"5d83e8b203c9192bd6777072\",\n \"locationname\": \"Chicago - IL\",\n \"clientLocation\": \"Chicago - IL\"\n },\n {\n \"_id\": \"5d83e8f803c919592e725536\",\n \"locationname\": \"San Francisco - CA\",\n \"clientLocation\": \"San Francisco - CA\"\n },\n {\n \"_id\": \"5d83e94403c91970582cfc22\",\n \"locationname\": \"New York - NY\",\n \"clientLocation\": \"New York - NY\"\n },\n {\n \"_id\": \"63d31a73d23ea95101062f74\",\n \"locationname\": \"Unassigned Location\",\n \"clientLocation\": \"Default\"\n },\n {\n \"_id\": \"6616aa79a9fe8d7b1406c262\",\n \"locationname\": \"Demo Client 1\",\n \"clientLocation\": \"Demo Client 1\"\n }\n ],\n \"message\": \"Locations\"\n}"}],"_postman_id":"6920a2b0-0952-4ae4-bfb4-a3f7dc9c5117"}],"id":"b4a8fd82-d92b-4b45-8f07-c53fac27886b","description":"You may have many distinct locations set up in your XAmplifier data. With this reseource you can access your location information. Use the returned location IDs in the 'Create an event' API.
\n","_postman_id":"b4a8fd82-d92b-4b45-8f07-c53fac27886b"},{"name":"Personnel","item":[{"name":"Personnel","id":"ca4bfee6-8719-4000-82ca-5d569442f05d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use the API authorization token found in the Xamplifier system to access this data. There are no parameters.
\n","urlObject":{"protocol":"https","path":["api","v1","personnels"],"host":["stage","dp","xamplifier","com"],"query":[],"variable":[]}},"response":[{"id":"29ce0721-abbe-4cb9-904c-0e8083de2cd4","name":"Get Personnel","originalRequest":{"method":"GET","header":[],"url":"https://api.xamplifier.com/api/v1/personnels"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Aug 2024 16:28:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=pQ47mIZ2KA9wrOzEe42kDavXwqp6GzAQCnZGPYh4; expires=Sat, 24-Aug-2024 18:28:19 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"_id\": \"661d32d87aa1db1c773c55a1\",\n \"clientCode\": \" \",\n \"alias\": \" \"\n },\n {\n \"_id\": \"5d8536ca03c91938f6553441\",\n \"clientCode\": \"Doctor\",\n \"alias\": \"Doctor\"\n },\n {\n \"_id\": \"5e0e304a03c91915d8704f61\",\n \"clientCode\": \"Dr. Bill Wilson\",\n \"alias\": \"Dr. Bill Wilson\"\n },\n {\n \"_id\": \"5e0e304a03c91915d8704f66\",\n \"clientCode\": \"Dr. Bob Smith\",\n \"alias\": \"Dr. Bob Smith\"\n },\n {\n \"_id\": \"661d31e00791952b8d65a6fd\",\n \"clientCode\": \"Dr. Neil SHah PHD, MD\",\n \"alias\": \"Dr. Neil SHah PHD, MD\"\n },\n {\n \"_id\": \"5d8536ca03c91938f6553447\",\n \"clientCode\": \"Medical Assistant\",\n \"alias\": \"Medical Assistant\"\n },\n {\n \"_id\": \"66bb41a15395bbfe5e0b4ee3\",\n \"clientCode\": \"Mr, Chew Wesley\",\n \"alias\": \"Mr, Chew Wesley\"\n },\n {\n \"_id\": \"5e0e304a03c91915d8704f6b\",\n \"clientCode\": \"PA Ebby Thatcher \",\n \"alias\": \"PA Ebby Thatcher \"\n },\n {\n \"_id\": \"661e263a16493a6f06055d04\",\n \"clientCode\": \"Paul Effen\",\n \"alias\": \"Paul Effen\"\n },\n {\n \"_id\": \"65f85be4ea2544011d1c2aa6\",\n \"clientCode\": \"Tolis Tester\",\n \"alias\": \"Tolis Tester\"\n },\n {\n \"_id\": \"5d83e94f03c919163e6bf3a2\",\n \"clientCode\": \"Unassigned\",\n \"alias\": null\n },\n {\n \"_id\": \"6508c955ab861016877c61ce\",\n \"clientCode\": \"Unassigned\",\n \"alias\": \"Unassigned\"\n }\n ],\n \"message\": \"Personnels\"\n}"}],"_postman_id":"ca4bfee6-8719-4000-82ca-5d569442f05d"}],"id":"344de480-4569-4017-a6ac-192483b931a6","description":"You may have many distinct providers set up in your XAmplifier data. With this reseource you can access your provider information. Use the returned personnelIDs in the Get reviews endpoint.
\n","_postman_id":"344de480-4569-4017-a6ac-192483b931a6"},{"name":"Surveys","item":[{"name":"Retrieve survey results","id":"61183342-5aad-49ee-9a70-86d8314164cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this resource to get the survey results that correspond to a given event ID within the system. The XAmplifier event ID is a required parameter. You must use the 'Retrieve all events' resource to get the event IDs for a particular survey (Survey ID) during a time period. IDs from the Insights dashboards will not work; only API IDs can be used in this resource.
\n","urlObject":{"protocol":"https","path":["api","v1","surveys","survey-results"],"host":["api","xamplifier","com"],"query":[{"description":{"content":"EventID from XA API. Pull the event IDs from the 'Retrieve all events' resource.
\n","type":"text/plain"},"key":"eventId","value":"6581e3a1a68f0726ac671f60"}],"variable":[]}},"response":[{"id":"00bddeae-a1af-4523-abe9-2e91949ce90c","name":"Retrieve survey results","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"eventId","value":"64b2ee988f175f37d211c07c","type":"text","disabled":true}]},"url":{"raw":"https://api.xamplifier.com/api/v1/surveys/survey-results?eventId=6581e31d37341753c31f0f49","protocol":"https","host":["api","xamplifier","com"],"path":["api","v1","surveys","survey-results"],"query":[{"key":"eventId","value":"6581e31d37341753c31f0f49"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Jan 2024 17:49:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=c7DrAD5ZZbJIQph05exEr6mzqHoWOq0FlB4Z02z0; expires=Wed, 03-Jan-2024 19:49:22 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"firstName\": \"Kathleen\",\n \"lastName\": \"Test\",\n \"email\": \"kkropp@xamplfier.com\",\n \"location\": \"Chicago - IL\",\n \"clientContactId\": \"1109202307\",\n \"serviceProviderName\": \"\",\n \"serviceDate\": null,\n \"completionDate\": \"2023-12-19 06:42:27pm\",\n \"nps\": null,\n \"surveyResults\": [\n {\n \"question\": \"On a scale of 0 to 10, please rate your level of satisfaction with your experience and treatment at Demo Client (10 being the best):\",\n \"answer\": \"6\"\n },\n {\n \"question\": \"What is the likelihood that you would suggest Demo Clientto a friend or family member looking for similar treatment? (10 being the greatest likelihood):\",\n \"answer\": \"1\"\n },\n {\n \"question\": \"Which factors were most important in choosing this location for your treatment? (choose any that apply)\",\n \"answer\": \"Quality of Medical Care, Insurance Types Accepted\"\n },\n {\n \"question\": \"Please indicate any areas in which you were NOT completely satisfied with your treatment or experience: (choose any that apply)\",\n \"answer\": \"Nursing Team Professionalism\"\n },\n {\n \"question\": \"Please share any additional thoughts about your medical treatment and its outcome:\",\n \"answer\": \"This is the second test survey for the demo client. Service could be better.\"\n },\n {\n \"question\": \"Please share any additional information or experiences regarding the doctors, nurses, and location staff (i.e., general respect and courtesy, followed up with you after the treatment, would you recommend them, etc ):\",\n \"answer\": \"Need to check the functioning of the survey results api\"\n },\n {\n \"question\": \"Do you consent to have any pertinent portions of your survey used by Demo Client's marketing department and/or shared for the benefit of other consumers on public forums? Your identity (last name) will never be included in any such usage.\",\n \"answer\": \"No\"\n },\n {\n \"question\": \"I wish to provide Demo Client with feedback on future visits via text message (SMS, MMS) for reviewing and marketing purposes.You may receive two (2) emails per visit or a maximum of four (4) emails per monthUnsubscribe at any time.\",\n \"answer\": \"Yes\"\n },\n {\n \"question\": \"On which social media(s) would you say you are generally the most active? (select any that apply):\",\n \"answer\": \"Youtube, LinkedIn, Instagram\"\n },\n {\n \"question\": \"If you have posted consumer reviews for any businesses or products in the past, which site(s) have you typically used? (select any that apply):\",\n \"answer\": \"RateMDs, Facebook Business Reviews\"\n }\n ]\n },\n \"message\": \"Survey Results\"\n}"},{"id":"ee60669b-96ab-405b-8bdd-4de567c87a6f","name":"Retrieve survey results","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"eventId","value":"64b2ee988f175f37d211c07c","type":"text","disabled":true}]},"url":{"raw":"https://api.xamplifier.com/api/v1/surveys/survey-results?eventId=6581e3a1a68f0726ac671f60","protocol":"https","host":["api","xamplifier","com"],"path":["api","v1","surveys","survey-results"],"query":[{"key":"eventId","value":"6581e3a1a68f0726ac671f60"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Jan 2024 18:11:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=c7DrAD5ZZbJIQph05exEr6mzqHoWOq0FlB4Z02z0; expires=Wed, 03-Jan-2024 20:11:03 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"firstName\": \"Tester 1\",\n \"lastName\": \"Tester 1\",\n \"email\": \"Kkropp@venatorpm.com\",\n \"location\": \"Chicago - IL\",\n \"clientContactId\": \"1109202307\",\n \"serviceProviderName\": \"\",\n \"serviceDate\": null,\n \"completionDate\": \"2023-12-19 06:43:59pm\",\n \"nps\": null,\n \"surveyResults\": [\n {\n \"question\": \"On a scale of 0 to 10, please rate your level of satisfaction with your experience and treatment at Demo Client (10 being the best):\",\n \"answer\": \"10\"\n },\n {\n \"question\": \"What is the likelihood that you would suggest Demo Clientto a friend or family member looking for similar treatment? (10 being the greatest likelihood):\",\n \"answer\": \"10\"\n },\n {\n \"question\": \"Which factors were most important in choosing this location for your treatment? (choose any that apply)\",\n \"answer\": \"Quality of Medical Care, Facility Location, Facility Ambiance or Cleanliness, Positive Online Reviews\"\n },\n {\n \"question\": \"Please indicate any areas in which you were NOT completely satisfied with your treatment or experience: (choose any that apply)\",\n \"answer\": \"Treatment Billing\"\n },\n {\n \"question\": \"Please share any additional thoughts about your medical treatment and its outcome:\",\n \"answer\": \"This is the third test survey for the demo client.\"\n },\n {\n \"question\": \"Please share any additional information or experiences regarding the doctors, nurses, and location staff (i.e., general respect and courtesy, followed up with you after the treatment, would you recommend them, etc ):\",\n \"answer\": \"Testing the survey results api\"\n },\n {\n \"question\": \"Do you consent to have any pertinent portions of your survey used by Demo Client's marketing department and/or shared for the benefit of other consumers on public forums? Your identity (last name) will never be included in any such usage.\",\n \"answer\": \"Yes\"\n },\n {\n \"question\": \"I wish to provide Demo Client with feedback on future visits via text message (SMS, MMS) for reviewing and marketing purposes.You may receive two (2) emails per visit or a maximum of four (4) emails per monthUnsubscribe at any time.\",\n \"answer\": \"Yes\"\n },\n {\n \"question\": \"On which social media(s) would you say you are generally the most active? (select any that apply):\",\n \"answer\": \"None of the above\"\n },\n {\n \"question\": \"If you have posted consumer reviews for any businesses or products in the past, which site(s) have you typically used? (select any that apply):\",\n \"answer\": \"I Don't Usually Post Online Reviews\"\n }\n ]\n },\n \"message\": \"Survey Results\"\n}"}],"_postman_id":"61183342-5aad-49ee-9a70-86d8314164cc"},{"name":"Retrieve surveys","id":"a3585117-d1c4-49ce-9e66-0ff86b35fccb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get a list of your valid XAmplifier survey type IDs that correspond to speciific survey names. The XAmplifier survey IDs are required to use the 'Create an event' resource. Your API authorization token is used and all your valid surveys are returned.
\n","urlObject":{"protocol":"https","path":["api","v1","surveys"],"host":["api","xamplifier","com"],"query":[],"variable":[]}},"response":[{"id":"3bfaf849-e3bb-401f-b82a-cd4113209402","name":"Retrieve surveys","originalRequest":{"method":"GET","header":[],"url":"https://api.xamplifier.com/api/v1/surveys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Oct 2023 19:31:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"_id\": \"5d83e86003c9191ec93cd983\",\n \"name\": \"Demo Client - Post-Service - Survey\"\n },\n {\n \"_id\": \"5d83e86803c9192497249fd3\",\n \"name\": \"Demo Client - Consultation - Survey\"\n }\n ],\n \"message\": \"Survey Types\"\n}"}],"_postman_id":"a3585117-d1c4-49ce-9e66-0ff86b35fccb"}],"id":"f12ba483-d819-4ab3-8e3a-3256e771661e","description":"This resource allows you to access your survey infomation stored in the XAmplifier system. The returned survey IDs from the 'Retrieve surveys' API will be used as a parameter in the 'Create an event' resource.
\n","_postman_id":"f12ba483-d819-4ab3-8e3a-3256e771661e"},{"name":"Aggregate Reviews","item":[{"name":"Retrieve aggregate reviews","id":"72e8a92d-0ca2-4f01-b396-8fb6ad5a44bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Month (Number) Valid values: January = 1, February = 2, March = 3, April = 4, May = 5, June = 6, July = 7, August = 8, September = 9, October = 10, November = 11, and December =12. *Required Field
\n","type":"text/plain"},"key":"month","value":"5"},{"description":{"content":"Year (Number). It should be a valid year between 2000 to Current Year 2024) *Required Field
\n","type":"text/plain"},"key":"year","value":"2024"},{"description":{"content":"Review Site (String) Current options: 'Google' or 'Yelp' *Required Field
\n","type":"text/plain"},"key":"reviewSite","value":"Yelp"},{"description":{"content":"Type of Panel (String) Valid values: 'location' or 'personnel' \n *Optional Field, when this parameter is not specified both types of panels are included
\n","type":"text/plain"},"key":"typeOfPanel","value":"location"}],"variable":[]}},"response":[{"id":"c8ce18e8-ff25-443a-8469-6bcb54f74e32","name":"Retrieve aggregate reviews","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xamplifier.com/api/v1/aggregate-reviews?month=5&year=2024&reviewSite=Google&typeOfPanel=location","protocol":"https","host":["api","xamplifier","com"],"path":["api","v1","aggregate-reviews"],"query":[{"key":"month","value":"5","description":"Month (Number) Valid values: January = 1, February = 2, March = 3, April = 4, May = 5, June = 6, July = 7, August = 8, September = 9, October = 10, November = 11, and December =12. *Required Field"},{"key":"year","value":"2024","description":"Year (Number). It should be a valid year betwwen 2000 to Current Year 2024) *Required Field"},{"key":"reviewSite","value":"Google","description":"Review Site (String) Current options: 'Google' or 'Yelp' *Required Field"},{"key":"typeOfPanel","value":"location","description":"Type of Panel (String) Valid values: 'location' or 'personnel' \n *Optional Field, when this parameter is not specified, both types of panels are included"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 10 Jun 2024 22:31:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.20.1"},{"key":"X-Powered-By","value":"PHP/8.0.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=ic9P7ILsccs82HPR3RPaZWuDhZecTFcXxRrZF6Kh; expires=Tue, 11-Jun-2024 00:31:20 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"location\": \"San Francisco - CA\",\n \"personnel\": \"N/A\",\n \"storeCode\": \"Southbury\",\n \"totalReviewsMTD\": 2,\n \"positiveReviewMTD\": 1,\n \"negativeReviewMTD\": 1,\n \"totalAvgRatingMTD\": 3,\n \"totalAllTimeReviews\": 44,\n \"totalAvgAllTimeRating\": 4.5,\n \"totalPriorReviews\": 0,\n \"totalAvgPriorRating\": 0\n },\n {\n \"location\": \"Demo Client 1\",\n \"personnel\": \"N/A\",\n \"storeCode\": \"N/A\",\n \"totalReviewsMTD\": 0,\n \"positiveReviewMTD\": 0,\n \"negativeReviewMTD\": 0,\n \"totalAvgRatingMTD\": 0,\n \"totalAllTimeReviews\": 1,\n \"totalAvgAllTimeRating\": 5,\n \"totalPriorReviews\": 0,\n \"totalAvgPriorRating\": 0\n }\n ],\n \"message\": \"Aggregate Reviews\"\n}"}],"_postman_id":"72e8a92d-0ca2-4f01-b396-8fb6ad5a44bf"}],"id":"199a6da5-05e5-407b-9394-2101f2e0bcd3","description":"The Aggregate Reviews resource provides aggregated review data for each review panel for a specified current month, prior month and for all-time as stored in the XAmplfier system. The returned review data will be for location panels, provider panels or both types as requested. The required parameters are \"month\", \"year\", and \"reviewSite\". Use the API authorization token to return all valid review data in the system for the parameters supplied. The response will include the location, personnel, storeCode, totalReviewsMTD, positiveReviewMTD, negativeReviewMTD,totalAvgRatingMTD, totalAllTimeReviews, totalAvgAllTimeRating, totalPriorReviews, and totalAvgPriorRating.
\n","_postman_id":"199a6da5-05e5-407b-9394-2101f2e0bcd3"},{"name":"Individual Reviews","item":[{"name":"Individual Reviews","id":"30a4611d-bd03-428f-a3ed-70717413651c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get review data for individual reviews including the review date, reviewer name, review text, rating, reply text, reply date, location name, provider name, and review site source.
\n","urlObject":{"protocol":"https","path":["api","v1","reviews"],"host":["api","xamplifier","com"],"query":[{"disabled":true,"description":{"content":"Start date of selected date range MM/DD/YYYY
\n","type":"text/plain"},"key":"fromReviewDate","value":"05/09/2024"},{"disabled":true,"description":{"content":"End date of selected date range MM/DD/YYYY
\n","type":"text/plain"},"key":"toReviewDate","value":"08/07/2024"},{"disabled":true,"description":{"content":"ID for the provider on the review panel of requested reviews. Get this ID from the Get Personnel endpoint.
\n","type":"text/plain"},"key":"personnelID","value":""},{"description":{"content":"Review site source - Google or Yelp. If not included both review sites will be included(if both are set up in XA)
\n","type":"text/plain"},"key":"site","value":"Google"},{"disabled":true,"description":{"content":"ID for the location on the review panel of requested reviews. Get this ID from the Get Locations endpoint.
\n","type":"text/plain"},"key":"endpointID","value":""}],"variable":[]}},"response":[{"id":"7598f0bb-41d9-4534-b42b-c02e34fd2d1b","name":"Individual Reviews","originalRequest":{"method":"GET","header":[{"key":"endpointID","value":"","type":"text"}],"url":{"raw":"https://api.xamplifier.com/api/v1/reviews?site=Google","protocol":"https","host":["api","xamplifier","com"],"path":["api","v1","reviews"],"query":[{"key":"fromReviewDate","value":"05/09/2024","description":"Start date of selected date range MM/DD/YYYY","disabled":true},{"key":"toReviewDate","value":"08/07/2024","description":"End date of selected date range MM/DD/YYYY","disabled":true},{"key":"personnelID","value":"","description":"ID for the provider of requested reviews. Get this ID from the Get Personnel endpoint.","disabled":true},{"key":"site","value":"Google","description":"Review site source - Google or Yelp. If not included both review sites will be included(if both are set up in XA) "},{"key":"endpointID","value":"","description":"ID for the location of requested reviews. Get this ID from the Get Locations endpoint.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Aug 2024 15:56:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"dp_session=pQ47mIZ2KA9wrOzEe42kDavXwqp6GzAQCnZGPYh4; expires=Sat, 24-Aug-2024 17:56:04 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"data\": [\n {\n \"reviewerName\": \"Niharika jhala\",\n \"reviewDate\": \"2018-01-27\",\n \"originalDate\": \"2018-01-27\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"No text\",\n \"reviewReply\": null,\n \"reviewReplyDate\": null,\n \"endpointId\": \"6616aa79a9fe8d7b1406c262\",\n \"endpointName\": \"Demo Client 1\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJQ5BCt_TFD4gRWVRXH5g2FLE\"\n },\n {\n \"reviewerName\": \"GubbySup vlog\",\n \"reviewDate\": \"2023-04-05\",\n \"originalDate\": \"2023-04-05\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"No text\",\n \"reviewReply\": \"Thank you for leaving your feedback! We strive to provide patients with positive health experiences. Thanks again and have a wonderful day.\",\n \"reviewReplyDate\": \"2023-04-05\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Ann Marie Bernstein\",\n \"reviewDate\": \"2022-09-20\",\n \"originalDate\": \"2022-09-20\",\n \"siteSource\": \"Google\",\n \"rating\": 1,\n \"reviewText\": \"I can't vouch for their service yet because they have cancelled my free consultation twice due to office emergencies, prior to the day of my appointment. If you don't want to honor the free consultation appointment, then just don't offer it, rather than have me reschedule my day because of your constant office emergencies. I don't understand how you have an emergency in advance of the day twice, but . . .\",\n \"reviewReply\": \"Thank you for providing your feedback. We take patient satisfaction very seriously and would like some more information to better understand your experience. Please email us at wecare@usaclinics.com so that we can speak with you directly regarding your concerns. We look forward to connecting with you soon.\",\n \"reviewReplyDate\": \"2022-11-09\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Asha A\",\n \"reviewDate\": \"2022-09-02\",\n \"originalDate\": \"2022-08-29\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"I highly recommend this office. The staff was very courteous and knowledgeable. Very clean and well maintained office. Both Dr. Baxt and the sonogram technician took their time explaining the procedure for my particular circumstance. I really appreciate them. I have already recommended them to my friends. Thank you all so very much.\",\n \"reviewReply\": \"Asha, thank you for your review!\",\n \"reviewReplyDate\": \"2022-08-30\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Rick Matschke\",\n \"reviewDate\": \"2022-07-15\",\n \"originalDate\": \"2022-07-15\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"No text\",\n \"reviewReply\": \"Rick, thank you for your review!\",\n \"reviewReplyDate\": \"2022-07-19\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Allison Stango\",\n \"reviewDate\": \"2022-06-28\",\n \"originalDate\": \"2022-06-28\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"Friendly & knowledgeable Dr & staff 😊\",\n \"reviewReply\": \"Allison, thank you for your review!\",\n \"reviewReplyDate\": \"2022-06-29\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Dorina Gjoni\",\n \"reviewDate\": \"2022-04-25\",\n \"originalDate\": \"2022-04-25\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"No text\",\n \"reviewReply\": \"Dorina, thank you so much for your review!\",\n \"reviewReplyDate\": \"2022-04-25\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Gina Bendlin\",\n \"reviewDate\": \"2022-03-21\",\n \"originalDate\": \"2022-03-21\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"No text\",\n \"reviewReply\": \"Gina, thank you for your rating!\",\n \"reviewReplyDate\": \"2022-03-22\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Rose Peterkin\",\n \"reviewDate\": \"2022-02-01\",\n \"originalDate\": \"2022-01-31\",\n \"siteSource\": \"Google\",\n \"rating\": 4,\n \"reviewText\": \"No text\",\n \"reviewReply\": \"Rose, thank you so much for your review!.\",\n \"reviewReplyDate\": \"2022-02-02\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n },\n {\n \"reviewerName\": \"Ralph Davino\",\n \"reviewDate\": \"2022-01-16\",\n \"originalDate\": \"2022-01-16\",\n \"siteSource\": \"Google\",\n \"rating\": 5,\n \"reviewText\": \"The staff is knowledgeable,friendly and attentive..Also they totally value your time..\",\n \"reviewReply\": \"Ralph, thank you for your review and feedback!\",\n \"reviewReplyDate\": \"2022-01-17\",\n \"endpointId\": \"5d83e8f803c919592e725536\",\n \"endpointName\": \"San Francisco - CA\",\n \"personnelID\": null,\n \"personnelName\": null,\n \"reviewUrl\": \"https://search.google.com/local/writereview?placeid=ChIJs8ossnnl54kRdPh0PDYaE3A\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 10,\n \"total_documents\": 45,\n \"total_pages\": 5\n }\n },\n \"message\": \"Review data\"\n}"}],"_postman_id":"30a4611d-bd03-428f-a3ed-70717413651c"}],"id":"7252c5c4-9b61-4c90-ae44-7bda9c13badf","description":"The Individual Reviews endpoint provides review data for Google or Yelp review panels for a specified location, provider and date range as stored in the XAmplifier system. The response returns all available data elements. There are no required parameters. Without parameters the response includes all reviews for all reputation panels set up in XAmplifier for all time for all activated review sites. The response will only include reviews from review site panels that are setup in XAmplifier and for review sites that are part of your XAmplifier package. Use the API authorization token to return all valid review data in the system for the parameters supplied.
\n","_postman_id":"7252c5c4-9b61-4c90-ae44-7bda9c13badf"}]}