Webinarinc Mystery Shop API (1.0.0)

Download OpenAPI specification:Download

Kyle Disher: admin@webinarinc.com URL: https://webinarinc.com License: Apache 2.0

API for Webinarinc's Mystery Shop

Authentication

API Key

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Get list of mystery shops requests

Get list of mystery shops

header Parameters

Accept

required

string

application/json

Request Body schema: application/json

ids	Array of any
date_from	string
date_to	string

Responses

Request samples

Payload

Content type

application/json

{"ids": [1,
2,
3
],
"date_from": "2021-02-01 01:10:00",
"date_to": "2021-02-04 01:10:00"
}

Response samples

200

Content type

application/json

{"id": 100,
"email_response_time": "2021-02-04 01:10:00",
"call_response_time": "2021-02-04 01:10:00",
"sms_response_time": "2021-02-04 01:10:00",
"email_attempts": 1,
"call_attempts": 2,
"sms_attempts": 3,
"lead": {"name": "Alfred S Brown",
"email": "AlfredSBrown@armyspy.com",
"phone_number": "+13182428264"
},
"salesperson_name": "Dorothy W. Hall",
"csm_name": "Charlotte W. Phillips",
"link": "https://app.webinarinc.com/client/internet-shop/123"
}

Create a mystery shop request

Create a new mystery shop request

header Parameters

Accept

required

string

application/json

Request Body schema: application/json

dealer_id required	integer
process_date required	string
notes	string
csm_name	string

Responses

Request samples

Payload

Content type

application/json

{"dealer_id": 0,
"process_date": "string",
"notes": "string",
"csm_name": "string"
}

Response samples

200

Content type

application/json

{"id": 100,
"email_response_time": "2021-02-04 01:10:00",
"call_response_time": "2021-02-04 01:10:00",
"sms_response_time": "2021-02-04 01:10:00",
"email_attempts": 1,
"call_attempts": 2,
"sms_attempts": 3,
"lead": {"name": "Alfred S Brown",
"email": "AlfredSBrown@armyspy.com",
"phone_number": "+13182428264"
},
"salesperson_name": "Dorothy W. Hall",
"csm_name": "Charlotte W. Phillips",
"link": "https://app.webinarinc.com/client/internet-shop/123"
}

Get a specific mystery shop request

path Parameters

id

required

integer

ID of the mystery shop

header Parameters

Accept

required

string

application/json

Responses

Response samples

200

Content type

application/json

{"id": 100,
"email_response_time": "2021-02-04 01:10:00",
"call_response_time": "2021-02-04 01:10:00",
"sms_response_time": "2021-02-04 01:10:00",
"email_attempts": 1,
"call_attempts": 2,
"sms_attempts": 3,
"lead": {"name": "Alfred S Brown",
"email": "AlfredSBrown@armyspy.com",
"phone_number": "+13182428264"
},
"salesperson_name": "Dorothy W. Hall",
"csm_name": "Charlotte W. Phillips",
"link": "https://app.webinarinc.com/client/internet-shop/123"
}

Delete a mystery shop request(only if the request status is open and not in-progress or completed)

Delete a mystery shop request(only if it's an OPEN status request)

path Parameters

id

required

integer

ID of the mystery shop

header Parameters

Accept

required

string

application/json

Responses

Update a mystery shop request

path Parameters

id

required

integer

ID of the mystery shop

header Parameters

Accept

required

string

application/json

Request Body schema: application/json

dealer_id required	integer
process_date required	string
notes	string
csm_name	string

Responses

Request samples

Payload

Content type

application/json

{"dealer_id": 0,
"process_date": "string",
"notes": "string",
"csm_name": "string"
}

Response samples

200

Content type

application/json

{"id": 100,
"email_response_time": "2021-02-04 01:10:00",
"call_response_time": "2021-02-04 01:10:00",
"sms_response_time": "2021-02-04 01:10:00",
"email_attempts": 1,
"call_attempts": 2,
"sms_attempts": 3,
"lead": {"name": "Alfred S Brown",
"email": "AlfredSBrown@armyspy.com",
"phone_number": "+13182428264"
},
"salesperson_name": "Dorothy W. Hall",
"csm_name": "Charlotte W. Phillips",
"link": "https://app.webinarinc.com/client/internet-shop/123"
}