# Profile API

### **Get List of Profiles By Channel, Account Id, Intent, Entity**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| URL        | http\://\[server]/dolphin/apiv1/graph/profiles?account=\*\&channel=\*\&intent=\*\&entity=\*\&start=0\&count=1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Header     | Authorization : Bearer \[generatedToken]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Response   | <p>{<br>“status”: “success”,<br>“data”: \[<br>    {      “id”: “\[id]”,<br>     “owner”: “\[owner\_id]”,<br>     “createdDate”: 1598855852591,<br>     “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,<br>     “modifiedDate”: 1598855852591,<br>     “modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,<br>     “accountId”: “\[accountId]”,<br>     “accountName”: “\[accountName]”,<br>     “channelName”: “\[channelName]”,<br>     “channelType”: “\[channelType]”,<br>     “status”: “PROMPT”,<br>     “entityName”: “\[entity\_name]”,<br>     “entityValue”: “\[entity\_value]”,<br>     “intent”: “\[intent]”,<br>     “message”: “\[message]”,<br>     “ticketNumber”: “\[ticketNumber]”,<br>     “intentType”: “DOMAIN”,<br>     “answer”: true,<br>     “master”: false<br>    }<br>],<br>“hasMore”: false,<br>“nextIndex”: 0,<br>“prevIndex”: 0,<br>“totalResults”: 0<br>}</p> |

### **Get List of Profiles**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| URL        | http\://\[server]/dolphin/apiv1/graph/profiles/data?start=0\&count=1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Header     | Authorization : Bearer \[generatedToken]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Response   | <p>{<br>“status”: “success”,<br>“data”: \[<br>    {      “id”: “\[id]”,<br>     “owner”: “\[owner\_id]”,<br>     “createdDate”: 1598856235880,<br>     “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,<br>     “modifiedDate”: 1598856235880,<br>     “modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,<br>     “accountId”: “\[accountId]”,<br>     “accountName”: “\[accountName]”,<br>     “channelName”: “\[channelName]”,<br>     “channelType”: “\[channelType]”,<br>     “status”: “PROMPT”,<br>     “entityName”: “\[entity\_name]”,<br>     “entityValue”: “\[entity\_value]”,<br>     “intent”: “\[intent]”,<br>     “message”: “\[message]”,<br>     “ticketNumber”: “\[ticketNumber]”,<br>     “intentType”: “DOMAIN”,<br>     “answer”: true,<br>     “master”: false<br>    }<br>],<br>“hasMore”: true,<br>“nextIndex”: 1,<br>“prevIndex”: 0,<br>“totalResults”: 83649<br>}</p> |

### **Get List of Profiles by Intent**

| Method     | GET                                                                                                                                                                 |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                    |
| URL        | http\://\[server]/dolphin/apiv1/graph/profiles/intent/\[intent]?start=0\&count=1                                                                                    |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>Intent : \[intent]</p>                                                                                               |
| Body       |                                                                                                                                                                     |
| Status     | 200                                                                                                                                                                 |
| Response   | <p>{<br>     “status”: “success”,<br>     “data”: \[],<br>     “hasMore”: false,<br>     “nextIndex”: 0,<br>     “prevIndex”: 0,<br>     “totalResults”: 0<br>}</p> |

### **Get List of Profiles by Entity**

| Method     | GET                                                                                                                                                                 |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                    |
| URL        | http\://\[server]/dolphin/apiv1/graph/profiles/entity/\[entity]?start=0\&count=1                                                                                    |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>Entity : \[entity]</p>                                                                                               |
| Body       |                                                                                                                                                                     |
| Status     | 200                                                                                                                                                                 |
| Response   | <p>{<br>     “status”: “success”,<br>     “data”: \[],<br>     “hasMore”: false,<br>     “nextIndex”: 0,<br>     “prevIndex”: 0,<br>     “totalResults”: 0<br>}</p> |

### **Get List of Profiles By Channel and Account Id**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| URL        | http\://\[server]/dolphin/apiv1/graph/profiles/channel/\[channel]/account/\[accountId]?start=0\&count=1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Header     | <p>Authorization : Bearer \[generateToken]<br>Channel : \[channelType]<br>Account : \[accountId]</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Response   | <p>{<br>     “status”: “success”,<br>     “data”: \[<br>    {      “id”: “\[id]”,<br>     “owner”: “\[owner\_id]”,<br>     “createdDate”: 1551145833236,<br>     “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,<br>     “modifiedDate”: 1551145833236,<br>     “modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,<br>     “botId”: “\[botId]”,<br>     “accountId”: “\[accountId]”,<br>     “accountName”: “\[accountName]”,<br>     “channelName”: “\[channelName]”,<br>     “channelType”: “\[channelType]”,<br>     “status”: “success”,<br>     “entityName”: “\[entity\_name]”,<br>     “entityValue”: “\[entity\_value]”,<br>     “intent”: “\[intent]”,<br>     “message”: “\[message]”,<br>     “ticketNumber”: “\[ticketNumber]”,<br>     “intentType”: “DOMAIN”,<br>     “answer”: false,<br>     “master”: false<br>    }<br>],<br>“hasMore”: false,<br>“nextIndex”: 0,<br>“prevIndex”: 0,<br>“totalResults”: 0<br>}</p> |

### **Get List of Profiles by Engagement Id**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| URL        | http\://\[server]/dolphin/apiv1/graph/profiles/\[engagementId]?start=0\&count=1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>EngagementId : \[engagementId]</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Response   | <p>{<br>     “status”: “success”,<br>     “data”: \[<br>    {      “id”: “\[id]”,<br>     “createdDate”: 1581576300573,<br>     “botId”: “\[botId]”,<br>     “accountId”: “\[accountId]”,<br>     “accountName”: “\[accountName]”,<br>     “channelName”: “\[channelName]”,<br>     “channelType”: “\[channelType]”,<br>     “status”: “SUCCESS”,<br>     “intent”: “\[intent]”,<br>     “message”: “\[message]”,<br>     “ticketNumber”: “\[ticketNumber]”,<br>     “intentType”: “DIALOG”,<br>     “answer”: true,<br>     “master”: false<br>     “master”: false<br>     “engagementId”: “\[engagementId]”<br>    }<br>],<br>“hasMore”: true,<br>“nextIndex”: 1,<br>“prevIndex”: 0,<br>“totalResults”: 4<br>}</p> |
