{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/portal.timetoreply.com" } ], "info": { "name": "timetoreply API Documentation", "_postman_id": "51e1165c-e113-4179-90b6-74093fff99db", "description": "This API is designed to let you do (almost) everything you can do from the timetoreply portal programmatically via API requests", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Reports", "description": "", "item": [ { "name": "Overview", "description": "", "item": [ { "name": "Overview - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/overview", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "sort_by", "value": "threads.total", "description": "Field Name to sort agents by. Defaults to threads.total.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "per_page_agents", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page_agents", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "per_page_contacts", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page_contacts", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "per_page_domains", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page_domains", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false }, { "key": "showHourOfDayForAgents", "value": "", "description": "Should we show the hour of day for agents.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/reports\/overview?from=2020-01-01&to=2020-01-08&model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&sort_by=threads.total&direction=desc&per_page_agents=2&page_agents=1&per_page_contacts=2&page_contacts=1&per_page_domains=2&page_domains=1&closed_over=15&viewId=1&showHourOfDayForAgents=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Overview Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1650.5749225616, app;desc=\"App\";dur=88, total;desc=\"Total\";dur=1652.5700092316, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Productivity", "description": "", "item": [ { "name": "Productivity - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/productivity", "query": [ { "key": "date", "value": "2020-01-01", "description": "The date of your request in the format \"YYYY-MM-DD\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "sort_by_email_volumes", "value": "messages_sent_count", "description": "Field Name to sort email volumes by. Defaults to messages_sent_count.", "disabled": false }, { "key": "direction_email_volumes", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "sort_by_conversations", "value": "threads_count", "description": "Field Name to sort conversations by. Defaults to threads_count.", "disabled": false }, { "key": "direction_conversations", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "sort_by_average_reply_times", "value": "initialTTR", "description": "Field Name to sort average reply times by. Defaults to initialTTR.", "disabled": false }, { "key": "direction_average_reply_times", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "sort_by_responsiveness", "value": "replies_under_7200", "description": "Field Name to sort responsiveness by. Defaults to replies_under_7200.", "disabled": false }, { "key": "direction_responsiveness", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "sort_by_activity", "value": "first_activity", "description": "Field Name to sort activity by. Defaults to first_activity.", "disabled": false }, { "key": "direction_activity", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/productivity?date=2020-01-01&model=My+Company&model_type=Internal&model_com=1&model_type_com=Contact+Group&per_page=2&page=1&sort_by_email_volumes=messages_sent_count&direction_email_volumes=desc&sort_by_conversations=threads_count&direction_conversations=desc&sort_by_average_reply_times=initialTTR&direction_average_reply_times=desc&sort_by_responsiveness=replies_under_7200&direction_responsiveness=desc&sort_by_activity=first_activity&direction_activity=desc&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Productivity Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1658.5068702698, app;desc=\"App\";dur=90, total;desc=\"Total\";dur=1660.4540348053, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Comparative", "description": "", "item": [ { "name": "Comparative - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/comparative", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/comparative?from=2020-01-01&to=2020-01-08&model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&per_page=2&direction=desc&page=1&closed_over=15&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Comparative Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1665.6820774078, app;desc=\"App\";dur=92, total;desc=\"Total\";dur=1667.4959659576, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Interactions", "description": "", "item": [ { "name": "Interactions - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/interactions", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "1", "description": "The ID or Name of the mailbox you want results for.", "disabled": false }, { "key": "model_type", "value": "Mailbox", "description": "Model Type of the mailbox being queried. For this report, it must be \"Mailbox\".", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/interactions?from=2020-01-01&to=2020-01-08&model=1&model_type=Mailbox&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&per_page=2&direction=desc&page=1&closed_over=15&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Interactions Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1673.4828948975, app;desc=\"App\";dur=94, total;desc=\"Total\";dur=1675.4200458527, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "SLA", "description": "", "item": [ { "name": "SLA - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/sla", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "sort_by", "value": "threads.total", "description": "Field Name to sort agents by. Defaults to threads.total.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "per_page_agents", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page_agents", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "per_page_contacts", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page_contacts", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "per_page_domains", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page_domains", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false }, { "key": "init_ttr_goal", "value": "02%3A00%3A00", "description": "Time string in the format \"HH:MM:SS\" of your initial reply time goal.", "disabled": false }, { "key": "overall_ttr_goal", "value": "02%3A00%3A00", "description": "Time string in the format \"HH:MM:SS\" of your overall reply time goal.", "disabled": false }, { "key": "overall_ttc_goal", "value": "02%3A00%3A00", "description": "Time string in the format \"HH:MM:SS\" of your overall Time to close goal.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/sla?from=2020-01-01&to=2020-01-08&model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&sort_by=threads.total&direction=desc&per_page_agents=2&page_agents=1&per_page_contacts=2&page_contacts=1&per_page_domains=2&page_domains=1&closed_over=15&viewId=1&init_ttr_goal=02%3A00%3A00&overall_ttr_goal=02%3A00%3A00&overall_ttc_goal=02%3A00%3A00" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "SLA Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1681.0350418091, app;desc=\"App\";dur=96, total;desc=\"Total\";dur=1682.9400062561, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Trend", "description": "", "item": [ { "name": "Trend - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/trend", "query": [ { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "date", "value": "2020-01-01", "description": "The date you want the report to go up to in the format \"YYYY-MM-DD\".", "disabled": false }, { "key": "periods", "value": "12", "description": "The number of date periods to show in the trend report. Must be less than 53 if choosing \"Weeks\" and less than 13 if choosing \"Months\".", "disabled": false }, { "key": "period_type", "value": "Months", "description": "The type of date period to break the report down into. Can be either \"Weeks\" or \"Months\".", "disabled": false }, { "key": "show_agents", "value": "1", "description": "Should we show the individual mailboxes in the report.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/trend?model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&date=2020-01-01&periods=12&period_type=Months&show_agents=1&closed_over=15&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Trend Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1688.5199546814, app;desc=\"App\";dur=98, total;desc=\"Total\";dur=1690.3970241547, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Contacts", "description": "", "item": [ { "name": "Contacts - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/contact", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "page_emails", "value": "1", "description": "For paginated results, which page to get for emails.", "disabled": false }, { "key": "per_page_emails", "value": "2", "description": "For paginated results, how many results per page for emails. Max 200.", "disabled": false }, { "key": "direction_emails", "value": "desc", "description": "Direction in which to sort email results. Must be either asc or desc.", "disabled": false }, { "key": "sort_by_emails", "value": "threads.total", "description": "Field Name to sort emails by. Defaults to threads.total.", "disabled": false }, { "key": "page_domains", "value": "1", "description": "For paginated results, which page to get for domains.", "disabled": false }, { "key": "per_page_domains", "value": "2", "description": "For paginated results, how many results per page for domains. Max 200.", "disabled": false }, { "key": "direction_domains", "value": "desc", "description": "Direction in which to sort domain results. Must be either asc or desc.", "disabled": false }, { "key": "sort_by_domains", "value": "threads.total", "description": "Field Name to sort domains by. Defaults to threads.total.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/contact?from=2020-01-01&to=2020-01-08&model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&page_emails=1&per_page_emails=2&direction_emails=desc&sort_by_emails=threads.total&page_domains=1&per_page_domains=2&direction_domains=desc&sort_by_domains=threads.total&closed_over=15&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Contacts Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1696.1100101471, app;desc=\"App\";dur=100, total;desc=\"Total\";dur=1697.9649066925, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Teams", "description": "", "item": [ { "name": "Teams - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/teams", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "1", "description": "The ID, Name of the team you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Team", "description": "Model Type of the model being queried. Can only be 'Internal' or 'Team'.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "sort_by", "value": "threads.total", "description": "Field Name to sort agents by. Defaults to threads.total.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/teams?from=2020-01-01&to=2020-01-08&model=1&model_type=Team&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&per_page=2&sort_by=threads.total&direction=desc&page=1&closed_over=15&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Teams Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1703.6070823669, app;desc=\"App\";dur=102, total;desc=\"Total\";dur=1705.5070400238, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Group Mailboxes", "description": "", "item": [ { "name": "Group Mailboxes - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/group-mailboxes", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "1", "description": "The ID or Name of the group mailbox you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Group+Mailbox", "description": "Model Type of the model being queried. Can only be 'Internal' or 'Group Mailbox'.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "sort_by", "value": "threads.total", "description": "Field Name to sort agents by. Defaults to threads.total.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/group-mailboxes?from=2020-01-01&to=2020-01-08&model=1&model_type=Group+Mailbox&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&per_page=2&sort_by=threads.total&direction=desc&page=1&closed_over=15&viewId=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Group Mailboxes Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1711.0409736633, app;desc=\"App\";dur=104, total;desc=\"Total\";dur=1712.9049301147, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Alerts", "description": "", "item": [ { "name": "Alerts - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/alerts", "query": [ { "key": "days", "value": "7", "description": "The number of days to go back in time.", "disabled": false }, { "key": "team", "value": "1", "description": "The ID of the team to filter by.", "disabled": false }, { "key": "agent", "value": "1", "description": "The ID of the mailbox to filter by.", "disabled": false }, { "key": "page_live", "value": "1", "description": "The page number for the live messages.", "disabled": false }, { "key": "per_page_live", "value": "10", "description": "The number of live messages per page.", "disabled": false }, { "key": "page_handled", "value": "1", "description": "The page number for the handled messages.", "disabled": false }, { "key": "per_page_handled", "value": "10", "description": "The number of handled messages per page.", "disabled": false }, { "key": "sort", "value": "desc", "description": "The sort order for the messages.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/alerts?days=7&team=1&agent=1&page_live=1&per_page_live=10&page_handled=1&per_page_handled=10&sort=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Alerts Report Data" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1719.28191185, app;desc=\"App\";dur=106, total;desc=\"Total\";dur=1721.1730480194, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Mailbox Alerts", "description": "", "item": [ { "name": "Alerts - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/alerts\/:agent_id", "query": [ { "key": "days", "value": "7", "description": "The number of days to go back in time.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number for the messages.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of messages per page.", "disabled": false }, { "key": "sort", "value": "desc", "description": "The sort order for the messages.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/alerts\/:agent_id?days=7&page=1&per_page=10&sort=desc", "variable": [ { "id": "agent_id", "key": "agent_id", "value": "1", "description": "The ID of the agent." }, { "id": "agent", "key": "agent", "value": "1", "description": "The ID of the mailbox to filter by." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Alerts Report Data for a specific mailbox" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1745.5770969391, app;desc=\"App\";dur=109, total;desc=\"Total\";dur=1748.7089633942, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] } ] }, { "name": "Logs", "description": "", "item": [ { "name": "Conversations", "description": "", "item": [ { "name": "Conversations - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/logs\/conversations", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "sort_by", "value": "last_received_at_date_time", "description": "Field Name to sort conversations (threads) by. Defaults to last_received_at_date_time.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "columns[0]", "value": "id", "description": "Allows you to select which columns you want to return.", "disabled": false }, { "key": "columns[1]", "value": "init_agent_reply_time", "description": "Allows you to select which columns you want to return.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false }, { "key": "unfilteredView", "value": "", "description": "Should we use the unfiltered view.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/logs\/conversations?from=2020-01-01&to=2020-01-08&model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&per_page=2&sort_by=last_received_at_date_time&direction=desc&page=1&closed_over=15&columns[0]=id&columns[1]=init_agent_reply_time&viewId=1&unfilteredView=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Conversation (Thread) Logs data\n The full list of available columns for the \"columns\" parameter are:\n- id\n- init_agent_reply_time\n- init_agent_action_time\n- total_agent_reply_time\n- last_received_at_date_time\n- thread_type\n- thread_status\n- raw_init_agent_reply_time\n- init_agent_reply_message_id\n- init_reply_agent_id\n- time_to_close\n- raw_time_to_close\n- friendly_initial_reply_time\n- friendly_raw_initial_reply_time\n- friendly_total_reply_time\n- microsoft_conversations\n- email_usernames\n- email_usernames_from\n- email_usernames_reply_to\n- email_usernames_senders\n- email_usernames_to\n- email_usernames_received\n- email_domains\n- date_times\n- message_classifications\n- message_subjects\n- messages\n- labels\n- has_contact_success\n- contact_success_time\n- contact_reply_time\n- subject\n- initial_reply_is_relevant\n- initial_reply_is_included_in_stats\n- initial_reply_is_outlier\n- friendly_time_to_close\n- friendly_raw_time_to_close\n- is_manually_excluded_from_sla_breach\n- customer_has_response\n- within_percentile_rank\n- messages.internet_message_id\n- messages.date_time\n- messages.timestamp\n- messages.subject\n- messages.references\n- messages.replytime\n- messages.classification\n- messages.raw_replytime\n- messages.friendly_reply_time\n- messages.friendly_raw_reply_time\n- messages.email_domains\n- messages.email_domains_from\n- messages.email_domains_to\n- messages.email_domains_reply_to\n- messages.email_domains_senders\n- messages.email_domains_received\n- messages.email_usernames\n- messages.email_usernames_from\n- messages.email_usernames_to\n- messages.email_usernames_cc\n- messages.email_usernames_reply_to\n- messages.email_usernames_senders\n- messages.email_usernames_received\n- messages.is_initial_reply\n- messages.is_newest_message\n- messages.message_type\n- messages.labels\n- messages.reply_is_relevant\n- messages.is_closing_email\n- messages.is_included_in_stats\n- messages.reply_is_outlier\n- messages.agents_read_status\n- messages.thread_id\n- messages.thread_message_count\n- messages.is_manually_excluded_from_sla_breach\n- messages.within_percentile_rank" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1632.052898407, app;desc=\"App\";dur=84, total;desc=\"Total\";dur=1635.0159645081, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Messages", "description": "", "item": [ { "name": "Messages - Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/logs\/messages", "query": [ { "key": "from", "value": "2020-01-01", "description": "The start date of your request in the format \"YYYY-MM-DD\". Must be less than or equal to \"to\".", "disabled": false }, { "key": "to", "value": "2020-01-08", "description": "The end date of your request in the format \"YYYY-MM-DD\". Must be greater than or equal to \"from\".", "disabled": false }, { "key": "model", "value": "My+Company", "description": "The ID, Name, email address or domain you want statistics for. Use the models endpoint to get a list.", "disabled": false }, { "key": "model_type", "value": "Internal", "description": "Model Type of the model being queried. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc", "value": "", "description": "Should we exclude CC messages from the statistics.", "disabled": true }, { "key": "model_com", "value": "1", "description": "Model Communicating With, same as Model, except now for who\/what the Model is communicating with.", "disabled": false }, { "key": "model_type_com", "value": "Contact+Group", "description": "Model Type of the model you are communicating with. Use \"Contact\" for email address and domain.", "disabled": false }, { "key": "exclude_cc_com", "value": "", "description": "Should we exclude CC messages from the statistics for the communicating with model.", "disabled": true }, { "key": "exclusive", "value": "", "description": "Should we only focus on statistics where exclusively Model and ModelCom were involved?.", "disabled": true }, { "key": "search", "value": "", "description": "Search a specific email subject line (warning this is very slow!).", "disabled": true }, { "key": "label[0]", "value": "INBOX", "description": "Label, if your mail provider supports labels\/categories, you can filter your results using them.", "disabled": false }, { "key": "labels_and_or", "value": "AND", "description": "Should we filter by all labels or any labels. Must be either \"AND\" or \"OR\".", "disabled": false }, { "key": "thread_type", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "thread_status", "value": "internal%2Cawait-customer%2Cclosed%2Cawait-agent", "description": "A comma separated list (no spaces) of any combination of the following: internal,await-customer,closed,await-agent.", "disabled": false }, { "key": "has_replies", "value": "hasReplies%2ChasForwards%2ChasNoRepliesOrForwards", "description": "A comma separated list (no spaces) of any combination of the following: hasReplies,hasForwards,hasNoRepliesOrForwards.", "disabled": false }, { "key": "classification", "value": "calculating%2Cfirst%2Creply%2Creply-all%2Cforward", "description": "A comma separated list (no spaces) of any combination of the following: calculating,first,reply,reply-all,forward,follow-up.", "disabled": false }, { "key": "messageType", "value": "inbound%2Coutbound%2Cinternal", "description": "A comma separated list (no spaces) of any combination of the following: inbound,outbound,internal.", "disabled": false }, { "key": "waiting_for_response", "value": "customer-has-response%2Cwaiting-for-response", "description": "A comma separated list (no spaces) of any combination of the following: customer-has-response,waiting-for-response.", "disabled": false }, { "key": "replies_over", "value": "15", "description": "Limit results to conversations with first reply times over X minutes. Should not be used at same time as message_replies_over.", "disabled": false }, { "key": "message_replies_over", "value": "15", "description": "Limit results to messages where the reply time was over X minutes. Should not be used at same time as replies_over.", "disabled": false }, { "key": "message_replies_under", "value": "15", "description": "Limit results to messages where the reply time was under X minutes.", "disabled": false }, { "key": "no_reply_for", "value": "15", "description": "Limit results to messages that have not had a reply for at least X minutes.", "disabled": false }, { "key": "per_page", "value": "2", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "sort_by", "value": "date_time", "description": "Field Name to sort messages by. Defaults to date_time.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction in which to sort paginated results. Must be either asc or desc.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "closed_over", "value": "15", "description": "Limit results to conversations closed over X minutes.", "disabled": false }, { "key": "columns[0]", "value": "date_time", "description": "Allows you to select which columns you want to return.", "disabled": false }, { "key": "columns[1]", "value": "subject", "description": "Allows you to select which columns you want to return.", "disabled": false }, { "key": "viewId", "value": "1", "description": "The ID of the view you want to use. This will pull in all the filters and settings from that view.", "disabled": false }, { "key": "unfilteredView", "value": "", "description": "Should we use the unfiltered view.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/logs\/messages?from=2020-01-01&to=2020-01-08&model=My+Company&model_type=Internal&exclude_cc=&model_com=1&model_type_com=Contact+Group&exclude_cc_com=&exclusive=&search=&label[0]=INBOX&labels_and_or=AND&thread_type=inbound%2Coutbound%2Cinternal&thread_status=internal%2Cawait-customer%2Cclosed%2Cawait-agent&has_replies=hasReplies%2ChasForwards%2ChasNoRepliesOrForwards&classification=calculating%2Cfirst%2Creply%2Creply-all%2Cforward&messageType=inbound%2Coutbound%2Cinternal&waiting_for_response=customer-has-response%2Cwaiting-for-response&replies_over=15&message_replies_over=15&message_replies_under=15&no_reply_for=15&per_page=2&sort_by=date_time&direction=desc&page=1&closed_over=15&columns[0]=date_time&columns[1]=subject&viewId=1&unfilteredView=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Message Logs data\nThe full list of available columns for the \"columns\" parameter are:\n- internet_message_id\n- date_time\n- timestamp\n- subject\n- references\n- replytime\n- classification\n- raw_replytime\n- friendly_reply_time\n- friendly_raw_reply_time\n- email_domains\n- email_domains_from\n- email_domains_to\n- email_domains_reply_to\n- email_domains_senders\n- email_domains_received\n- email_usernames\n- email_usernames_from\n- email_usernames_to\n- email_usernames_cc\n- email_usernames_reply_to\n- email_usernames_senders\n- email_usernames_received\n- is_initial_reply\n- is_newest_message\n- message_type\n- labels\n- reply_is_relevant\n- is_closing_email\n- is_included_in_stats\n- reply_is_outlier\n- agents_read_status\n- thread_id\n- thread_message_count\n- is_manually_excluded_from_sla_breach\n- within_percentile_rank" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1641.8950557709, app;desc=\"App\";dur=86, total;desc=\"Total\";dur=1644.210100174, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] } ] }, { "name": "Entities", "description": "", "item": [ { "name": "Mailboxes", "description": "", "item": [ { "name": "Mailboxes - List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/entities\/mailboxes", "query": [ { "key": "sort_by", "value": "name", "description": "The field to sort the mailboxes by.", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort asc or desc.", "disabled": false }, { "key": "per_page", "value": "2", "description": "The number of mailboxes to show per page.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "search", "value": "", "description": "Optional search string.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/entities\/mailboxes?sort_by=name&direction=asc&per_page=2&page=1&search=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all mailboxes" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1496.6979026794, app;desc=\"App\";dur=74, total;desc=\"Total\";dur=1571.7749595642, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Contacts", "description": "", "item": [ { "name": "Contacts - List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/entities\/contacts", "query": [ { "key": "sort_by", "value": "name", "description": "The field to sort the customers by.", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort asc or desc.", "disabled": false }, { "key": "per_page", "value": "25", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "search", "value": "", "description": "Optional search string.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/entities\/contacts?sort_by=name&direction=asc&per_page=25&page=1&search=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all existing contacts." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1603.4789085388, app;desc=\"App\";dur=80, total;desc=\"Total\";dur=1605.565071106, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Contact Groups", "description": "", "item": [ { "name": "Contact Groups - List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/entities\/contact-groups", "query": [ { "key": "sort_by", "value": "name", "description": "The field to sort the mailboxes by.", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort asc or desc.", "disabled": false }, { "key": "per_page", "value": "15", "description": "The number of contact groups to show per page.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "search", "value": "", "description": "Optional search string.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/entities\/contact-groups?sort_by=name&direction=asc&per_page=15&page=1&search=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all Contact Groups" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1610.5198860168, app;desc=\"App\";dur=81, total;desc=\"Total\";dur=1612.263917923, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Group Mailboxes", "description": "", "item": [ { "name": "Group Mailboxes - List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/entities\/group-mailboxes", "query": [ { "key": "per_page", "value": "25", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "search", "value": "Sales", "description": "For searching by name.", "disabled": false }, { "key": "sort_by", "value": "name", "description": "Field to sort by.", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort direction.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/entities\/group-mailboxes?per_page=25&page=1&search=Sales&sort_by=name&direction=asc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show all Group Mailboxes" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1587.8639221191, app;desc=\"App\";dur=76, total;desc=\"Total\";dur=1590.0368690491, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Teams", "description": "", "item": [ { "name": "Teams - List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/entities\/teams", "query": [ { "key": "per_page", "value": "25", "description": "For paginated results, how many results per page. Max 200.", "disabled": false }, { "key": "page", "value": "1", "description": "For paginated results, which page to get.", "disabled": false }, { "key": "sort_by", "value": "name", "description": "Field to sort by.", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort direction.", "disabled": false }, { "key": "search", "value": "ACME", "description": "Search term to filter by.", "disabled": false }, { "key": "include_emails", "value": "", "description": "Include email addresses of members in the response.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/entities\/teams?per_page=25&page=1&sort_by=name&direction=asc&search=ACME&include_emails=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show all teams" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "tracking-events", "value": "[]" }, { "key": "server-timing", "value": "bootstrap;desc=\"Bootstrap\";dur=1596.1790084839, app;desc=\"App\";dur=78, total;desc=\"Total\";dur=1598.0799198151, " }, { "key": "x-ttr-server", "value": "homestead-rob" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] } ] }, { "name": "Tools", "description": "", "item": [ { "name": "Profile", "description": "", "item": [ { "name": "Profile - Get", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/me", "query": [], "raw": "{{baseUrl}}\/api\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Your account basic data" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"1\",\"name\":\"Peter Rabbit\",\"email\":\"p.rabbit@timetoreply.com\"}", "name": "" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }