These API calls allow accessing past chatlogs, adding users or updating their fields, adding agents, and more.

Note that we sometimes use 'user' and 'SDFuser' interchangeably to refer to a user. An ID of a user is referred to with SDFuserid for backward compatibility.

Note that agent cannot be \"admin\" or \"superadmin\" and it has to be an existing role.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Creates and activates an agent alert. If adminId or agentRole is not specified, alerts are shown to everyone.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

The request body must be a JSON object with the given fields (also see examples):

This request will return an array of agent alerts within the SmartBot360 system.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Note that agent cannot be \"admin\" or \"superadmin\" and it must be an existing role.

Arguments

The request body must be a JSON object with the given fields (also see examples):

This request sets the availability status of an agent. 0 is unavailable and 1 is available.

Arguments

The request body must be a JSON object with the given fields if the message is text (also see examples):

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

The request body must be a JSON object with the given fields (also see examples):

Add a user in the user database. SDFUserid will be returned if successful. If a key in input parameter is not present in SDFuser table, it will be added as a column to allow specifying more {key, value} pairs.

Arguments

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Retrieves the \"users\" table in \"Analytics\" page as a JSON object. Users are filtered using startDate and endDate based on the timestamp of the last message sent by a user.\nNote that for GMT timezone, you should pass \"+00:00\" and not \"00:00\".

Arguments

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Return the database(s) where the SDFuser is based on. Given a phone number, this API returns the database(s) names as a list or returns \"not found\" if the user does not exist.

Arguments

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

This call will set or update the login for a user. If no SDFuserid is provided, it will create a new user with just a username, password, and SDFuserid assigned.

Arguments

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

The request body must be a JSON object with the given fields (also see examples):

Get notes of users along with all attributes of notes table (visibility, isPinned etc) within a specified time range. If given a particular SDFuserid, all notes of that user within that specified time will be returned.

Arguments

Retrieves the \"Chat Logs\" table in \"Analytics\" page as a JSON object, excluding web chats in which the user did not send a message.

Arguments

Get a specific saved business variables for your account. Returns a 404 if the given name does not exist.

Arguments

Set (Create or update) a business variables for your account. Returns a 200 on success, otherwise a bad request if the required parameters are not present.

Arguments

Delete a business variables for your account. Returns a 200 on success, otherwise a bad request if the required parameters are not present.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Notes: Phone numbers must be in the format like +12223334444, where +1 is the country code.

Generate a presigned URL for the specified Event trigger. This only applies to S3 event triggers created via the Event Triggers tab on the Automation page. Returns a 404 when the specified triggerId was previously deleted, or does not exist.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

name	required	type	doc
role	optional	string	Agent's role, default value is agent
agentEmail	required	string	Agent's email
firstName	required	string	Agent's first name
lastName	required	string	Agent's last name
securityToken	required	string	Security token

name	required	type	doc
message	required	string	Alert message
securityToken	required	string	Security token
adminId	optional	int	Admin ID
agentRole	optional	int	Agent role

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
securityToken	required	string	Security token

name	required	type	doc
alertId	required	int	Alert ID
securityToken	required	string	Security token

name	required	type	doc
agentEmail	required	string	Agent's email
newRole	required	string	Agent's new role
securityToken	required	string	Security token

name	required	type	doc
agentEmail	required	string	Agent's email
securityToken	required	string	Security token

name	required	type	doc
agentEmail	required	string	Agent's email
securityToken	required	string	Security token

name	required	type	doc
userPhone	required	string	User's phone number
securityToken	required	string	Security token

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
flagName	required	string	Flag name
securityToken	required	string	Security token

name	required	type	doc
SDFuserid	required	string	SDFuserid
fieldName	required	string	Name of the field
securityToken	required	string	Security token

name	required	type	doc
userPhone	required	string	User's phone number
fieldName	required	string	Name of the field
securityToken	required	string	Security token

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
securityToken	required	string	Security token

name	required	type	doc
SDFuserid	optional	integer	User's ID
username	required	string	the username you wish to set for this users login, 50 character max
password	required	string	the password that you wish this user to log in with
securityToken	required	string	Security token

name	required	type	doc
userPhone	required	string	User's phone number
fieldName	required	string	Name of the field
fieldType	optional	string	Can only be \"int\", \"float\", \"dateTime\" or \"varchar(4096)\"
value	required	string	Value
securityToken	required	string	Security token

name	required	type	doc
SDFuserid	required	string	SDFuserid
fieldName	required	string	Name of the field
fieldType	optional	string	Can only be \"int\", \"float\", \"dateTime\" or \"varchar(4096)\"
value	required	string	Value
securityToken	required	string	Security token

name	required	type	doc
SDFuserid	required	string	SDFuserid
securityToken	required	string	Security token
fields	required	json	Field names and values

name	required	type	doc
userPhone	required	string	User's phone number
securityToken	required	string	Security token
fields	required	json	Field names and values

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
flagName	required	string	Flag name
securityToken	required	string	Security token

name	required	type	doc
startTime1	required	string	startTime range 1
startTime2	required	string	startTime range 2
securityToken	required	string	Security token
batch	required	integer	Get Xth batch of 20 results

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
patternLabel	required	string	Pattern label can be found on dashboard
activationTime	optional	string	Can be empty (now) or in the format of \"YYYY-mm-dd hh:mm:ss\", time must be in UTC
securityToken	required	string	Security token

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
patternLabel	required	string	Pattern label can be found on dashboard
securityToken	required	string	Security token

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
securityToken	required	string	Security token

name	required	type	doc
userPhone	see doc	string	User's phone number, optional if SDFuserid is given
SDFuserid	see doc	string	User's ID, optional if userPhone is given
securityToken	required	string	Security token

name	required	type	doc
triggerId	required	number	The trigger number found on the Event Trigger table.
securityToken	required	string	Security token

name	required	type	doc
pageIndex	optional	number	offset
pageSize	optional	number	amount of documents to return
sortBy	optional	string
sortDirection	optional	string
securityToken	required	string	Security token

The request body may be form-data or JSON depending on your goals. See the examples for more information.

If using form-data , files may be uploaded directly via the documents field with type file. This is useful for direct upload from a local file.

If using json, files may be provided as a list of urls. this is useful if you want to upload remote files. The urls must be open to public requests.

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

name	required	type	doc
documentId	required	string
securityToken	required	string	Security token

The request body may be form-data or JSON depending on your goals. See the examples for more information.

If using form-data , files may be uploaded directly via the documents field with type file. This is useful for direct upload from a local file.

If using json, files may be provided as a list of urls. this is useful if you want to upload remote files. The urls must be open to public requests.

Arguments

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

Arguments

The request body must be a JSON object with the given fields (also see examples):

Arguments

Publishes a bot so it may be used for medium deployment. functionID must be a bot obtained from the CHATBOTS page.

Arguments

Publishes a bot so it may be used for medium deployment. functionID must be a bot obtained from the CHATBOTS page & the bot for functionID should have already been published.

Arguments

\\\\

\\\\\\n \\ (function() { \\\\n var smartbot360 \\= document.getElementById(\\\\\\\"smartbot360\\\\\\\");\\\\n var script \\= document.createElement(\\\\\\\"script\\\\\\\");\\\\n smartbot360.setAttribute(\\\\\\\"botkey\\\\\\\", \\\\\\\"uuid-string\\\\\\\");\\\\n script.setAttribute(\\\\\\\"type\\\\\\\", \\\\\\\"text/javascript\\\\\\\");\\\\n script.setAttribute(\\\\\\\"src\\\\\\\", \\\\\\\"https://test.klaunch.io/react/static/js/main.js\\\\\\\");\\\\n document.body.appendChild(script);\\\\n})(); \\\\\\n\\\"\",\r\n \"previewURL\": \"https://test.klaunch.io/#/public/preview/web/uuid-string\",\r\n \"deploymentID\": 12345\r\n}"}],"_postman_id":"7281db6d-d59c-41ec-b6bd-42a94130fbff"},{"name":"List Deployments","id":"b85df06f-87a6-4549-8e8d-8510e61af120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$\",\r\n \"functionID\": \"MyChatbotName\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/deployments/list","description":"

Lists a bot's deployments.

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	type	doc
securityToken	required	string	Security token
functionID	required	string	bot name

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","chatbots","deployments","list"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"f0632607-1d9b-44f3-a4e5-c02742545af7","name":"List Deployments","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$\",\r\n \"functionID\": \"MyChatbotName\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/deployments/list"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\r\n {\r\n \"listening\": 1,\r\n \"functionID\": \"MyChatbotName\",\r\n \"handoffWebBotID\": 0,\r\n \"deploymentID\": 123,\r\n \"mediumID\": 456,\r\n \"active\": 1,\r\n \"onceOnly\": 0,\r\n \"medium\": \"web\"\r\n }\r\n]"}],"_postman_id":"b85df06f-87a6-4549-8e8d-8510e61af120"},{"name":"Get Web Bot Attributes","id":"56800cc9-c96f-4274-9153-8a19d3c57365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$\",\r\n \"deploymentID\": 123\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/attributes/get","description":"

Retrieves a Web bot deployment's attributes.

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	type	doc
securityToken	required	string	Security token
deploymentID	required	number	Deployment ID

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","chatbots","attributes","get"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"490baaef-c72d-4688-b287-bd5297188145","name":"Get Web Bot Attributes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$\",\r\n \"deploymentID\": 123\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/attributes/get"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"talktoagent\": \"true\",\r\n \"hidewindow\": \"false\",\r\n \"headerColor\": \"#000efd\",\r\n \"botTitle\": \"bottitle1234\",\r\n \"userMessageColor\": \"#0000FF\",\r\n \"userMessageFontColor\": \"#eff366\"\r\n}"}],"_postman_id":"56800cc9-c96f-4274-9153-8a19d3c57365"},{"name":"Update Web Bot Attributes","id":"ca8577af-a41b-4500-af4f-d70bca0951a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$\",\r\n \"deploymentID\": 123,\r\n \"attributeForm\": {\"botTitle\": \"MyChatBot\"}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/attributes/update","description":"

Updates a Web bot deployment's attributes.

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	type	doc
securityToken	required	string	Security token
deploymentID	required	number	Deployment ID
attributeForm	required	JSON object	Contains Web bot attribute names and values

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","chatbots","attributes","update"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"72749313-ad3e-48ae-ab9c-c6e4b4511c9d","name":"Update Web Bot Attributes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$\",\r\n \"deploymentID\": 123,\r\n \"attributeForm\": {\"botTitle\": \"MyChatBot\"}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/attributes/update"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"talktoagent\": \"true\",\r\n \"hidewindow\": \"false\",\r\n \"headerColor\": \"#000efd\",\r\n \"botTitle\": \"MyChatBot\",\r\n \"userMessageColor\": \"#0000FF\",\r\n \"userMessageFontColor\": \"#eff366\"\r\n}"}],"_postman_id":"ca8577af-a41b-4500-af4f-d70bca0951a6"},{"name":"List Web Bot Attribute Types","id":"0689aa8c-977a-43a0-a7ff-6915aca9767d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/attributes/types","description":"

Lists all possible Web bot attributes and their types.

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	type	doc
securityToken	required	string	Security token

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","chatbots","attributes","types"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"95a638f7-2c75-48f2-9fa2-eb2790f9a9da","name":"List Web Bot Attribute Types","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/chatbots/attributes/types"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"attributeTypes\": {\r\n \"boolean\": \"A standard boolean. May also be passed as a string (case-insensitive).\",\r\n \"string\": \"A standard string.\",\r\n \"agent_status\": \"A string, either 'boolean,' 'estimatedTime,' or 'off' (case-insensitive).\",\r\n \"integer\": \"A standard integer. May also be passed as a string.\",\r\n \"hexidecimal\": \"A string consisting of # followed by six hexidecimal digits (0-9 and A-F, case-insensitive).\"\r\n },\r\n \"attributes\": {\r\n \"delaydisplayseconds\": \"integer\",\r\n \"headerLogo\": \"string\",\r\n \"fontsize\": \"string\",\r\n \"footerfontsize\": \"string\",\r\n \"talktoagent\": \"boolean\",\r\n \"quickReplyBorderColor\": \"hexadecimal\",\r\n \"hidewindow\": \"boolean\",\r\n \"botheight\": \"string\",\r\n \"chatsessionExpiredMessage\": \"string\",\r\n \"headerColor\": \"hexadecimal\",\r\n \"hideEmojiButton\": \"boolean\",\r\n \"invalidHandoffLinkMessage\": \"string\",\r\n \"expandedBotWidth\": \"string\",\r\n \"botTitle\": \"string\",\r\n \"botMessageColor\": \"hexadecimal\",\r\n \"evalpopup\": \"integer\",\r\n \"quickReplyColor\": \"hexadecimal\",\r\n \"agentstatus\": \"agent_status\",\r\n \"disableChatDownload\": \"boolean\",\r\n \"botName\": \"string\",\r\n \"hidewindowmobile\": \"boolean\",\r\n \"chaticon\": \"string\",\r\n \"botwidth\": \"string\",\r\n \"banner\": \"integer\",\r\n \"popmessage\": \"string\",\r\n \"expandedBotHeight\": \"string\",\r\n \"userMessageColor\": \"hexadecimal\",\r\n \"stylePackage\": \"integer\",\r\n \"bkgrndimg\": \"string\",\r\n \"picture\": \"boolean\",\r\n \"timeperuser\": \"integer\",\r\n \"userMessageFontColor\": \"hexadecimal\",\r\n \"quickReplyFontColor\": \"hexadecimal\",\r\n \"chatavatar\": \"string\",\r\n \"popupboticon\": \"string\",\r\n \"embeddable\": \"boolean\",\r\n \"headerFontColor\": \"hexadecimal\",\r\n \"useChatBar\": \"boolean\",\r\n \"botMessageFontColor\": \"hexadecimal\",\r\n \"font\": \"string\"\r\n }\r\n}"}],"_postman_id":"0689aa8c-977a-43a0-a7ff-6915aca9767d"}],"id":"9ffab04f-f0b9-4d8f-9640-b1432bb956a3","_postman_id":"9ffab04f-f0b9-4d8f-9640-b1432bb956a3","description":""},{"name":"Banners Management","item":[{"name":"List Banners","id":"e64df3bf-178b-429c-bf0c-01696f56ff22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/list","description":"

Retrieve all web bot banners in the account. Returns a list of banner objects including their configuration, active status, and date ranges.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security token

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","banners","list"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"7f6dc5d7-74e8-4e49-985b-efd8756aa7eb","name":"List Banners","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/list"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.12.2"},{"key":"Date","value":"Sat, 06 Jun 2026 04:34:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"736"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"endDate\": \"2026-06-05 00:00:00.0\",\n \"name\": \"a\",\n \"active\": true,\n \"attributes\": \"

Test Banner

This is a message

\",\n \"id\": 32,\n \"startDate\": \"2026-05-28 00:00:00.0\"\n },\n {\n \"endDate\": \"2026-05-28 00:00:00.0\",\n \"name\": \"test1\",\n \"active\": false,\n \"attributes\": \"

This is a message

\",\n \"id\": 22,\n \"startDate\": \"2026-05-21 00:00:00.0\"\n },\n {\n \"endDate\": \"2026-05-16 00:00:00.0\",\n \"name\": \"Test Banner\",\n \"active\": false,\n \"attributes\": \"

Test Banner

This is a message!

\",\n \"id\": 20,\n \"startDate\": \"2026-05-14 00:00:00.0\"\n }\n]"}],"_postman_id":"e64df3bf-178b-429c-bf0c-01696f56ff22"},{"name":"Create Banner","id":"5b118c4f-d5af-4e76-98ea-da6f669f8e7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"name\": \"test804\",\n \"attributes\": \"

This is a message

\",\n \"startDate\": \"2026-06-10\",\n \"endDate\": \"2026-06-20\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/create","description":"

Create a new banner with a specified date range. The banner will be created in an active state by default and can be displayed to users between the start and end dates.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
name	required	string	Display name for the banner
attributes	required	string	JSON string containing banner configuration in HTML (e.g., message, styling, type)
startDate	required	string	Start date in format \"YYYY-MM-DD\"
endDate	required	string	End date in format \"YYYY-MM-DD\"
securityToken	required	string	Security token

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","banners","create"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"31371eab-7567-42a5-9f60-480b1d4cd276","name":"Create Banner","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"name\": \"test804\",\n \"attributes\": \"

This is a message

\",\n \"startDate\": \"2026-06-10\",\n \"endDate\": \"2026-06-20\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/create"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.12.2"},{"key":"Date","value":"Sat, 06 Jun 2026 04:44:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"133"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"endDate\": \"2026-06-20 00:00:00.0\",\n \"name\": \"test804\",\n \"active\": true,\n \"attributes\": \"

This is a message

\",\n \"id\": 33,\n \"startDate\": \"2026-06-10 00:00:00.0\"\n}"}],"_postman_id":"5b118c4f-d5af-4e76-98ea-da6f669f8e7a"},{"name":"Update Banner","id":"a97b708c-8c1c-4fce-89af-be0ad8265273","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 30,\n \"name\": \"asdf\",\n \"attributes\": \"

This is a message

\",\n \"startDate\": \"2026-06-10\",\n \"endDate\": \"2026-06-20\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/update","description":"

Updates an existing banner by ID. You can modify the banner's name, attributes, active status, and date range. At least one optional field must be provided for the update to succeed.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
id	required	optional	User's phone number, optional if SDFuserid is given
name	optional	string	New display name for the banner
attributes	optional	string	New JSON string containing banner configuration
active	optional	int	Enable (1) or disable (0) the banner
startDate	optional	string	New start date/time in format \"YYYY-MM-DD\"
endDate	optional	string	New end date/time in format \"YYYY-MM-DD\"
securityToken	required	string	Security token

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","banners","update"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"0a8bbc91-2b63-4ad1-bafe-a9d6b4399177","name":"Update Banner","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 30,\n \"name\": \"asdf\",\n \"attributes\": \"

This is a message

\",\n \"startDate\": \"2026-06-10\",\n \"endDate\": \"2026-06-20\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/update"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.12.2"},{"key":"Date","value":"Sat, 06 Jun 2026 04:47:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": \"Updated banner 30\"\n}"}],"_postman_id":"a97b708c-8c1c-4fce-89af-be0ad8265273"},{"name":"Delete Banner","id":"dead385f-84bb-45d7-bb29-f178b7f63898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 30\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/banners/delete","description":"

Permanently deletes a banner by its ID.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
id	required	int	Banner ID to delete
securityToken	required	string	Security token

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","banners","delete"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"3abf5015-0110-4232-a267-fc9a855c60a4","name":"Delete Banner","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 30\n}"},"url":"https://dev.klaunch.io/chatapi/smartdash/public/banners/delete"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.12.2"},{"key":"Date","value":"Sat, 06 Jun 2026 04:50:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": \"Deleted banner 30\"\n}"}],"_postman_id":"dead385f-84bb-45d7-bb29-f178b7f63898"}],"id":"6df9813d-9490-45df-8e13-8338ebd88451","_postman_id":"6df9813d-9490-45df-8e13-8338ebd88451","description":""},{"name":"User Blocking Management","item":[{"name":"List Blocked Users","id":"d1792b8f-b5f1-40a8-a1c9-abd587883188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/users/blocked/list","description":"

Retrieve all blocked users.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security token
blockingRuleId	no	int	Retrieve users blocked by this rule ID
page	no	int	Page number for pagination
pageSize	no	int	Number of items per page

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","blocking-rules","users","blocked","list"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"a32fa805-2384-4dfa-9909-edff77a11a84","name":"List Blocked Users","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/users/blocked/list"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Tue, 16 Jun 2026 05:54:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"342"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"sdfUserID\": 101588,\n \"databaseID\": 51,\n \"blockingRule\": 1,\n \"blockTime\": \"2026-05-07 18:52:31\"\n },\n {\n \"sdfUserID\": 101590,\n \"databaseID\": 51,\n \"blockingRule\": 1,\n \"blockTime\": \"2026-05-07 18:52:31\"\n },\n {\n \"sdfUserID\": 103811,\n \"databaseID\": 51,\n \"blockingRule\": 21,\n \"blockTime\": \"2026-05-07 23:37:42\"\n },\n {\n \"sdfUserID\": 103841,\n \"databaseID\": 51,\n \"blockingRule\": 24,\n \"blockTime\": \"2026-05-12 03:34:29\"\n },\n {\n \"sdfUserID\": 103842,\n \"databaseID\": 51,\n \"blockingRule\": 23,\n \"blockTime\": \"2026-05-12 04:05:44\"\n },\n {\n \"sdfUserID\": 103844,\n \"databaseID\": 51,\n \"blockingRule\": 24,\n \"blockTime\": \"2026-05-12 04:06:36\"\n },\n {\n \"sdfUserID\": 103845,\n \"databaseID\": 51,\n \"blockingRule\": 9,\n \"blockTime\": \"2026-05-12 14:03:04\"\n },\n {\n \"sdfUserID\": 103846,\n \"databaseID\": 51,\n \"blockingRule\": 23,\n \"blockTime\": \"2026-05-12 14:09:09\"\n },\n {\n \"sdfUserID\": 103853,\n \"databaseID\": 51,\n \"blockingRule\": 2,\n \"blockTime\": \"2026-05-13 17:22:00\"\n },\n {\n \"sdfUserID\": 103854,\n \"databaseID\": 51,\n \"blockingRule\": 2,\n \"blockTime\": \"2026-05-13 17:33:04\"\n },\n {\n \"sdfUserID\": 103864,\n \"databaseID\": 51,\n \"blockingRule\": 9,\n \"blockTime\": \"2026-05-15 14:31:21\"\n },\n {\n \"sdfUserID\": 103872,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-21 20:01:11\"\n },\n {\n \"sdfUserID\": 103873,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-21 20:44:13\"\n },\n {\n \"sdfUserID\": 103875,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-21 20:54:55\"\n },\n {\n \"sdfUserID\": 103876,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-21 21:10:45\"\n },\n {\n \"sdfUserID\": 103877,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-21 21:14:38\"\n },\n {\n \"sdfUserID\": 103878,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-21 21:25:35\"\n },\n {\n \"sdfUserID\": 103884,\n \"databaseID\": 51,\n \"blockingRule\": 4,\n \"blockTime\": \"2026-05-22 18:31:38\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"pageSize\": 50,\n \"totalCount\": 18,\n \"totalPages\": 1\n }\n}"}],"_postman_id":"d1792b8f-b5f1-40a8-a1c9-abd587883188"},{"name":"List Blocking Rules","id":"7b14a9dd-4eb5-459a-8ba5-8fb562d37d7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/list","description":"

Retrieve all blocking rules in the account.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security token

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","blocking-rules","list"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"4845fd26-753f-4023-9a1d-65bb28c204e8","name":"List Blocking Rules","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\"\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/list"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Mon, 15 Jun 2026 19:09:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"214"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"durationMinutes\": 0,\n \"regex\": \"test_blocking3\",\n \"messagesPerInterval\": 0,\n \"intervalMinutes\": 0,\n \"id\": 4\n },\n {\n \"durationMinutes\": 60,\n \"regex\": \"\",\n \"messagesPerInterval\": 10,\n \"intervalMinutes\": 1,\n \"id\": 5\n },\n {\n \"durationMinutes\": 60,\n \"regex\": \"^abcd\\\\?$\",\n \"messagesPerInterval\": 0,\n \"intervalMinutes\": 0,\n \"id\": 8\n },\n {\n \"durationMinutes\": 5,\n \"regex\": \"Colorado\",\n \"messagesPerInterval\": 0,\n \"intervalMinutes\": 0,\n \"id\": 9\n }\n]"}],"_postman_id":"7b14a9dd-4eb5-459a-8ba5-8fb562d37d7f"},{"name":"Create Blocking Rule","id":"87829307-d2f0-4eff-842a-5ef50c70fa4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"regex\": \"Colorado\",\n \"durationMinutes\": 1440\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/create","description":"

Create a new blocking rule. Fails if we specify both regex and messagesPerInterval/intervalMinutes.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security token
regex	optional	string	Pattern to match against user messages for blocking
messagesPerInterval	optional	int	Number of messages allowed before blocking
intervalMinutes	optional	int	Interval in minutes for rate limiting (used with messagesPerInterval)
durationMinutes	optional	int	Duration in minutes to block the user

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","blocking-rules","create"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"42886ede-e4fe-407a-a0cd-ef043132fccd","name":"Create Blocking Rule","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"regex\": \"Colorado\",\n \"durationMinutes\": 1440\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/create"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Tue, 16 Jun 2026 06:00:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"99"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"durationMinutes\": 1440,\n \"regex\": \"Colorado\",\n \"messagesPerInterval\": 0,\n \"intervalMinutes\": 0,\n \"id\": 52\n}"}],"_postman_id":"87829307-d2f0-4eff-842a-5ef50c70fa4c"},{"name":"Update Blocking Rule","id":"717fcfda-5fb8-4416-b7a9-cb63c4020daf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 52,\n \"regex\": \"Michigan\",\n \"messagesPerInterval\": 15,\n \"intervalMinutes\": 10,\n \"durationMinutes\": 2880\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/update","description":"

Update an existing blocking rule. Fails if we specify both regex and messagesPerInterval/intervalMinutes.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security token
id	required	int	ID of the rule to update
regex	optional	string	Pattern to match against user messages for blocking
messagesPerInterval	optional	int	Number of messages allowed before blocking
intervalMinutes	optional	int	Interval in minutes for rate limiting (used with messagesPerInterval)
durationMinutes	optional	int	Duration in minutes to block the user

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","blocking-rules","update"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"3363fcc6-b0be-498a-b4c8-dd2789fa3107","name":"Update Blocking Rule","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 52,\n \"regex\": \"Michigan\",\n \"messagesPerInterval\": 15,\n \"intervalMinutes\": 10,\n \"durationMinutes\": 2880\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/update"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Tue, 16 Jun 2026 06:03:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"104"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"durationMinutes\": 2880,\n \"regex\": \"Michigan\",\n \"messagesPerInterval\": 15,\n \"intervalMinutes\": 10,\n \"id\": 52\n}"}],"_postman_id":"717fcfda-5fb8-4416-b7a9-cb63c4020daf"},{"name":"Delete Blocking Rule","id":"1ea58fe0-c1a2-4523-b449-72bb703e4a3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 52\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/delete","description":"

Delete an existing blocking rule.

Arguments

The request body must be a JSON object with the given fields (also see examples):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security token
id	required	int	ID of the rule to delete

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","blocking-rules","delete"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"c91ac8d9-3710-47f4-8911-cc0e27fc5ba2","name":"Delete Blocking Rule","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"securityToken\": \"$\",\n \"id\": 52\n}"},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/blocking-rules/delete"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Tue, 16 Jun 2026 06:06:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"104"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"durationMinutes\": 2880,\n \"regex\": \"Michigan\",\n \"messagesPerInterval\": 15,\n \"intervalMinutes\": 10,\n \"id\": 52\n}"}],"_postman_id":"1ea58fe0-c1a2-4523-b449-72bb703e4a3e"}],"id":"9acef9cd-5780-46e5-bd7f-4e14b213cc33","_postman_id":"9acef9cd-5780-46e5-bd7f-4e14b213cc33","description":""},{"name":"Analytics Schedule Management","item":[{"name":"List Analytics Report Schedules","id":"b2eb5367-ee8a-4128-823c-926e81ec6ef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"page\": 1,\r\n \"pageSize\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/list","description":"

Retrieves a list of analytics report schedules.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
page	required	int	Page number
pageSize	required	int	Number of schedules per page

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","schedules","list"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"8b77a0c6-9ff4-44a9-8b06-893fbcd21d5c","name":"List Analytics Report Schedules","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"page\": 1,\r\n \"pageSize\": 2\r\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\r\n {\r\n \"cronExpression\": \"0 */30 * * * *\",\r\n \"createdAt\": \"2026-05-22 23:05:34.0\",\r\n \"reportWindowSeconds\": 31536000,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"lastRun\": {\r\n \"createdAt\": \"2026-06-26 19:30:19.0\",\r\n \"id\": 2825,\r\n \"type\": \"SCHEDULED\",\r\n \"scheduleId\": 39,\r\n \"status\": \"SUCCEEDED\",\r\n \"updatedAt\": \"2026-06-26 19:30:20.0\"\r\n },\r\n \"id\": 39,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 465,\r\n \"updatedAt\": \"2026-05-27 06:52:43.0\"\r\n },\r\n {\r\n \"cronExpression\": \"* 5 4 1 1 1\",\r\n \"createdAt\": \"2026-05-21 14:53:20.0\",\r\n \"reportWindowSeconds\": 31536000,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"lastRun\": {\r\n \"createdAt\": \"2026-06-23 22:59:20.0\",\r\n \"id\": 2549,\r\n \"type\": \"MANUAL\",\r\n \"scheduleId\": 38,\r\n \"status\": \"SUCCEEDED\",\r\n \"updatedAt\": \"2026-06-23 22:59:29.0\"\r\n },\r\n \"id\": 38,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 425,\r\n \"updatedAt\": \"2026-06-08 19:08:56.0\"\r\n }\r\n]"}],"_postman_id":"b2eb5367-ee8a-4128-823c-926e81ec6ef1"},{"name":"Get Analytics Report Schedule","id":"56e7f36a-a59a-4901-a2c5-7f75a250dd30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 52\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/get","description":"

Retrieve an analytics report schedule.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
scheduleId	required	int	ID of analytics report schedule

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","schedules","get"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"70d7ac77-eb94-468b-b0e1-fa2bce463b9e","name":"Get Analytics Report Schedule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 52\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/get"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"cronExpression\": \"0 */30 * * * *\",\r\n \"createdAt\": \"2026-06-27 00:12:02.0\",\r\n \"reportWindowSeconds\": 60,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"lastRun\": {\r\n \"createdAt\": \"2026-06-30 19:01:21.0\",\r\n \"id\": 3382,\r\n \"type\": \"SCHEDULED\",\r\n \"scheduleId\": 52,\r\n \"status\": \"SUCCEEDED\",\r\n \"updatedAt\": \"2026-06-30 19:01:22.0\"\r\n },\r\n \"id\": 52,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 218,\r\n \"updatedAt\": \"2026-06-27 00:12:02.0\"\r\n}"}],"_postman_id":"56e7f36a-a59a-4901-a2c5-7f75a250dd30"},{"name":"Create Analytics Report Schedule","id":"db9f0dd3-d9fe-47e0-8c08-fdeb7bbeb29c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"reportId\": 1,\r\n \"adminIds\": [12, 34],\r\n \"reportWindowSeconds\": 600,\r\n \"cronExpression\": \"0 */30 * * * *\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/create","description":"

Creates an analytics report schedule.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
reportId	required	int	ID of analytics report
adminIds	required	array of ints	IDs of admins to assign to this schedule
reportWindowSeconds	required	int	Window to gather report data from, in seconds
cronExpression	required	string	Expression to specify report frequency and timing

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","schedules","create"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"9c73c1a6-65a9-4886-8960-cd237d73f316","name":"Create Analytics Report Schedule","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"reportId\": 1,\r\n \"adminIds\": [12, 34],\r\n \"reportWindowSeconds\": 600,\r\n \"cronExpression\": \"0 */30 * * * *\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/create"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\r\n {\r\n \"cronExpression\": \"0 */30 * * * *\",\r\n \"createdAt\": \"2026-06-26 23:57:07.0\",\r\n \"reportWindowSeconds\": 600,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"id\": 51,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 12,\r\n \"updatedAt\": \"2026-06-26 23:57:07.0\"\r\n },\r\n {\r\n \"cronExpression\": \"0 */30 * * * *\",\r\n \"createdAt\": \"2026-06-26 23:57:07.0\",\r\n \"reportWindowSeconds\": 600,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"id\": 51,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 34,\r\n \"updatedAt\": \"2026-06-26 23:57:07.0\"\r\n }\r\n]"}],"_postman_id":"db9f0dd3-d9fe-47e0-8c08-fdeb7bbeb29c"},{"name":"Update Analytics Report Schedule","id":"6e2bb19c-9266-4fe6-bef4-a065c3bfbef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 51,\r\n \"adminId\": 12,\r\n \"reportWindowSeconds\": 1200,\r\n \"cronExpression\": \"0 */30 * * * *\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/update","description":"

Updates an analytics report schedule.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
scheduleId	required	int	ID of analytics report schedule
adminId	required	int	ID of admin the schedule is assigned to
reportWindowSeconds	required	int	Window to gather report data from, in seconds
cronExpression	required	string	Expression to specify report frequency and timing

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","schedules","update"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"c3981a75-423c-47d8-8581-750a2c3d4bb8","name":"Update Analytics Report Schedule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 51,\r\n \"adminId\": 12,\r\n \"reportWindowSeconds\": 1200,\r\n \"cronExpression\": \"0 */30 * * * *\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/update"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"cronExpression\": \"0 */30 * * * *\",\r\n \"createdAt\": \"2026-06-26 23:57:07.0\",\r\n \"reportWindowSeconds\": 1200,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"lastRun\": {\r\n \"createdAt\": \"2026-06-27 00:00:19.0\",\r\n \"id\": 2850,\r\n \"type\": \"SCHEDULED\",\r\n \"scheduleId\": 51,\r\n \"status\": \"SUCCEEDED\",\r\n \"updatedAt\": \"2026-06-27 00:00:20.0\"\r\n },\r\n \"id\": 51,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 12,\r\n \"updatedAt\": \"2026-06-27 00:06:07.0\"\r\n}"}],"_postman_id":"6e2bb19c-9266-4fe6-bef4-a065c3bfbef0"},{"name":"Delete Analytics Report Schedule","id":"a3cf1bdb-4ad6-4655-93ac-b10c9ddc692a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 46\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/delete","description":"

Deletes an analytics report schedule.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
scheduleId	required	int	ID of analytics report schedule

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","schedules","delete"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"b930746b-d45d-402c-93f3-1d5ae61688e9","name":"Delete Analytics Report Schedule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 46\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/delete"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"cronExpression\": \"0 */30 * * * *\",\r\n \"createdAt\": \"2026-06-26 23:57:07.0\",\r\n \"reportWindowSeconds\": 600,\r\n \"instanceId\": 6,\r\n \"deleted\": false,\r\n \"reportId\": 1,\r\n \"lastRun\": {\r\n \"createdAt\": \"2026-06-27 00:00:19.0\",\r\n \"id\": 2850,\r\n \"type\": \"SCHEDULED\",\r\n \"scheduleId\": 51,\r\n \"status\": \"SUCCEEDED\",\r\n \"updatedAt\": \"2026-06-27 00:00:20.0\"\r\n },\r\n \"id\": 51,\r\n \"instanceDatabaseId\": 51,\r\n \"instanceAgentId\": 12,\r\n \"updatedAt\": \"2026-06-27 00:06:07.0\"\r\n}"}],"_postman_id":"a3cf1bdb-4ad6-4655-93ac-b10c9ddc692a"},{"name":"Run Analytics Report Schedule","id":"3b2f720f-efd4-481d-a746-22cd4ff09176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 52\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/run","description":"

Runs an analytics report schedule.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
scheduleId	required	int	ID of analytics report schedule

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","schedules","run"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"c03ec439-5719-4231-aad1-d73faef6bc01","name":"Run Analytics Report Schedule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"scheduleId\": 52\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/schedules/run"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": \"Successfully ran scheduled report with schedule ID '52' for database '$DB'.\"\r\n}"}],"_postman_id":"3b2f720f-efd4-481d-a746-22cd4ff09176"},{"name":"Get Analytics Report","id":"aeb7e6e9-3c15-4989-93a6-d28993128d9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"reportId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/reports/get","description":"

Retrieve an analytics report.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
reportId	required	int	ID of analytics report

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","reports","get"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"5d8ab1e4-1806-492c-afb7-a1137dae5fa0","name":"Get Analytics Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"reportId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/reports/get"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"createdAt\": \"2026-04-29 20:44:51.0\",\r\n \"deleted\": false,\r\n \"name\": \"Message & Users\",\r\n \"description\": \"A report of key usage metrics related to messages & users in the account\",\r\n \"id\": 1,\r\n \"parameters\": {\r\n \"flag\": {\r\n \"name\": \"flag\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"abc\"\r\n },\r\n \"endDate\": {\r\n \"name\": \"endDate\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\"\r\n },\r\n \"startDate\": {\r\n \"name\": \"startDate\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\"\r\n }\r\n },\r\n \"updatedAt\": \"2026-06-01 16:17:29.0\"\r\n}"}],"_postman_id":"aeb7e6e9-3c15-4989-93a6-d28993128d9a"},{"name":"List Analytics Reports","id":"c2cb71a8-b6e0-46f2-be71-2f082fcf09a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"page\": 1,\r\n \"pageSize\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/reports/list","description":"

Retrieves a list of analytics reports.

Arguments

The request body must be a JSON object with the given fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	type	doc
securityToken	required	string	Security Token
page	required	int	Page number
pageSize	required	int	Number of reports per page

","urlObject":{"protocol":"https","path":["chatapi","smartdash","public","analytics","reports","list"],"host":["XXX","smartbot360","com"],"query":[],"variable":[]}},"response":[{"id":"840570de-6c3e-4458-aef3-61e0fd01addf","name":"List Analytics Reports","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"securityToken\": \"$TOKEN\",\r\n \"page\": 1,\r\n \"pageSize\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXX.smartbot360.com/chatapi/smartdash/public/analytics/reports/list"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\r\n {\r\n \"createdAt\": \"2026-06-05 08:33:21.0\",\r\n \"deleted\": false,\r\n \"name\": \"Test\",\r\n \"description\": \"asd\",\r\n \"id\": 21,\r\n \"parameters\": {\r\n \"flag\": {\r\n \"name\": \"flag\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"flag\"\r\n },\r\n \"endDate\": {\r\n \"name\": \"endDate\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\"\r\n },\r\n \"startDate\": {\r\n \"name\": \"startDate\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\"\r\n }\r\n },\r\n \"updatedAt\": \"2026-06-05 08:33:21.0\"\r\n },\r\n {\r\n \"createdAt\": \"2026-06-05 08:12:15.0\",\r\n \"deleted\": false,\r\n \"name\": \"a112\",\r\n \"description\": \"asd\",\r\n \"id\": 20,\r\n \"parameters\": {\r\n \"flag\": {\r\n \"name\": \"flag\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"abc\"\r\n },\r\n \"endDate\": {\r\n \"name\": \"endDate\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\"\r\n },\r\n \"startDate\": {\r\n \"name\": \"startDate\",\r\n \"description\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"abc\"\r\n }\r\n },\r\n \"updatedAt\": \"2026-06-10 06:48:03.0\"\r\n }\r\n]"}],"_postman_id":"c2cb71a8-b6e0-46f2-be71-2f082fcf09a3"}],"id":"b610eb25-ae42-4f35-9a39-58a6c8f1974b","_postman_id":"b610eb25-ae42-4f35-9a39-58a6c8f1974b","description":""}]}

name	required	type	doc
append_instructions	optional	boolean	If true, given instructions are appended to existing instructions
append_training	optional	boolean	If true, given training is appended to existing training
instructions	optional	string	GenAI instructions
securityToken	required	string	Security token
temperature	optional	number between 0 and 2	GenAI temperature setting
top_p	optional	number between 0 and 1	GenAI top p setting
training	optional	string	Gen AI training data