{"id":31839819,"url":"https://github.com/jayco/helpscout-mailbox-v2-reports","last_synced_at":"2025-10-12T04:22:38.588Z","repository":{"id":56876242,"uuid":"247410089","full_name":"jayco/helpscout-mailbox-v2-reports","owner":"jayco","description":"Client for HelpScout V2 Mailbox Reports","archived":false,"fork":false,"pushed_at":"2023-03-17T02:26:50.000Z","size":128,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-27T21:39:14.177Z","etag":null,"topics":["helpscout","helpscout-api","rest-client","ruby","ruby-gem","rubygem","rubygems"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jayco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-15T05:53:30.000Z","updated_at":"2020-03-17T06:18:20.000Z","dependencies_parsed_at":"2023-02-12T05:30:21.736Z","dependency_job_id":null,"html_url":"https://github.com/jayco/helpscout-mailbox-v2-reports","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/jayco/helpscout-mailbox-v2-reports","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayco%2Fhelpscout-mailbox-v2-reports","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayco%2Fhelpscout-mailbox-v2-reports/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayco%2Fhelpscout-mailbox-v2-reports/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayco%2Fhelpscout-mailbox-v2-reports/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jayco","download_url":"https://codeload.github.com/jayco/helpscout-mailbox-v2-reports/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayco%2Fhelpscout-mailbox-v2-reports/sbom","scorecard":{"id":508863,"data":{"date":"2025-08-11","repo":{"name":"github.com/jayco/helpscout-mailbox-v2-reports","commit":"90ef98b64cd432bb6c3bb3370472c4bedc7de514"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.1,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating ruby:2.7 to ruby:2.7@sha256:2347de892e419c7160fc21dec721d5952736909f8c3fbb7f84cb4a07aaf9ce7d","Info: 0 out of 1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-2p68-f74v-9wc6","Warn: Project is vulnerable to: GHSA-cr5q-6q9f-rq6q","Warn: Project is vulnerable to: GHSA-j6gc-792m-qgm2","Warn: Project is vulnerable to: GHSA-pj73-v5mw-pm9j","Warn: Project is vulnerable to: GHSA-jxhc-q857-3j6g","Warn: Project is vulnerable to: GHSA-5cm2-9h8c-rvfx"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T23:59:57.707Z","repository_id":56876242,"created_at":"2025-08-19T23:59:57.707Z","updated_at":"2025-08-19T23:59:57.707Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278839611,"owners_count":26054970,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helpscout","helpscout-api","rest-client","ruby","ruby-gem","rubygem","rubygems"],"created_at":"2025-10-12T04:22:33.374Z","updated_at":"2025-10-12T04:22:38.574Z","avatar_url":"https://github.com/jayco.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Helpscout::Mailbox::V2::Reports\n\n[![Build status](https://badge.buildkite.com/37c6409bd0d3a5b2ba10b4a6c2edd6092ecda4d7704c7ece16.svg)](https://buildkite.com/jayco/helpscout-mailbox-v2-reports) [![Gem Version](https://badge.fury.io/rb/helpscout-mailbox-v2-reports.svg)](https://badge.fury.io/rb/helpscout-mailbox-v2-reports)\n\nSimple to use client for interacting with the [Report Endpoints](https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-overall) for the HelpScout V2 Mailbox API\n\nIt uses the following HelpScout gems:\n\n- [Helpscout::Api::Auth](https://github.com/jayco/helpscout-api-auth.git)\n- [Helpscout::Mailbox::Paths](https://github.com/jayco/helpscout-mailbox-paths.git)\n- [Helpscout::Mailbox::V2::Client](https://github.com/jayco/helpscout-mailbox-v2-client)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'helpscout-mailbox-v2-reports'\n```\n\nAnd then execute:\n\n $ bundle install\n\nOr install it yourself as:\n\n $ gem install helpscout-mailbox-v2-reports\n\n## Usage\n\n#### Table of Contents\n\n[Initialization](#Initialization)\n\n[Company Reports](#Company-Reports)\n\n- [get_company](#get_company)\n- [get_company_customers_helped](#get_company_customers_helped)\n- [get_company_drilldown](#get_company_drilldown)\n\n[Conversation Reports](#Conversation-Reports)\n\n- [get_conversations](#get_conversations)\n- [get_conversations_new_conversations](#get_conversations_new_conversations)\n- [get_conversations_channel_volumes](#get_conversations_channel_volumes)\n- [get_conversations_busiest_times](#get_conversations_busiest_times)\n- [get_conversations_drilldown](#get_conversations_drilldown)\n- [get_conversations_drilldown_by_field](#get_conversations_drilldown_by_field)\n- [get_conversations_new_conversations_drilldown](#get_conversations_new_conversations_drilldown)\n- [get_conversations_received_message_stats](#get_conversations_received_message_stats)\n\n[Doc Reports](#Doc-Reports)\n\n- [get_docs](#get_docs)\n\n[Happiness Reports](#Happiness-Reports)\n\n- [get_happiness](#get_happiness)\n- [get_happiness_ratings](#get_happiness_ratings)\n\n[Productivity Reports](#Productivity-Reports)\n\n- [get_productivity](#get_productivity)\n- [get_productivity_first_response_time](#get_productivity_first_response_time)\n- [get_productivity_replies_sent](#get_productivity_replies_sent)\n- [get_productivity_resolution_time](#get_productivity_resolution_time)\n- [get_productivity_resolved](#get_productivity_resolved)\n- [get_productivity_response_time](#get_productivity_response_time)\n\n[User Reports](#User-Reports)\n\n- [get_user](#get_user)\n- [get_user_conversation_history](#get_user_conversation_history)\n- [get_user_customers_helped](#get_user_customers_helped)\n- [get_user_drilldown](#get_user_drilldown)\n- [get_user_happiness](#get_user_happiness)\n- [get_user_happiness_drilldown](#get_user_happiness_drilldown)\n- [get_user_replies](#get_user_replies)\n- [get_user_resolutions](#get_user_resolutions)\n\n[Chat Reports](#Chat-Reports)\n\n- [get_chat](#get_chat)\n\n[Email Reports](#Email-Reports)\n\n- [get_email](#get_email)\n\n[Phone Reports](#Phone-Reports)\n\n- [get_phone](#get_phone)\n\n### Initialization\n\nCreates a new Client class and authorises the client with HelpScout\n\n| Parameter | Type | Description |\n| :-------------- | :------- | :--------------------------------------------------------------------- |\n| `client_id` | `string` | **Required** HelpScout API client id |\n| `client_secret` | `string` | **Required** HelpScout API client secret |\n| `base_url` | `string` | **Optional** HelpScout API url (defaults to https://api.helpscout.net) |\n\n```ruby\nrequire 'helpscout/mailbox/v2/reports'\n\nclient = Helpscout::Mailbox::V2::Reports::Client.new(client_id: 'some id', client_secret: 'keep it secret')\n# =\u003e 'BMEv1lmcNgDBpOFNHo8TPlODMrF3BG5T'\n\n```\n\n### Company Reports\n\n#### get_company\n\nThe company report provides statistics about your company performance over a given time range. You may optionally specify two time ranges to see how performance changed between the two ranges.\n\nMaps to [Company Overall Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-overall)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_company\n# =\u003e\n# {\n# \"filterTags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\"\n# } ],\n# \"current\" : {\n# \"startDate\" : \"2015-01-01T00:00:00Z\",\n# \"endDate\" : \"2015-01-31T23:59:59Z\",\n# \"customersHelped\" : 28,\n# \"closed\" : 94,\n# \"totalReplies\" : 62,\n# \"totalUsers\" : 5,\n# \"totalDays\" : 30,\n# \"repliesPerDayPerUser\" : 0.41333333333333333,\n# \"repliesPerDay\" : 2.066666666666667,\n# \"resolvedPerDay\" : 0.03333333333333333\n# },\n# \"previous\" : {\n# \"startDate\" : \"2014-01-01T00:00:00Z\",\n# \"endDate\" : \"2014-01-31T23:59:59Z\",\n# \"customersHelped\" : 27,\n# \"closed\" : 49,\n# \"totalReplies\" : 636,\n# \"totalUsers\" : 4,\n# \"totalDays\" : 30,\n# \"repliesPerDayPerUser\" : 5.3,\n# \"repliesPerDay\" : 21.2,\n# \"resolvedPerDay\" : 0.4666666666666667\n# },\n# \"deltas\" : {\n# \"customersHelped\" : 3.703703703703698,\n# \"totalReplies\" : -90.25157232704403,\n# \"repliesPerDay\" : -90.25157232704403,\n# \"closed\" : 91.83673469387755,\n# \"totalUsers\" : 25.0,\n# \"repliesPerDayPerUser\" : -92.20125786163523\n# },\n# \"users\" : [ {\n# \"customersHelped\" : 26,\n# \"happinessScore\" : 66.66666666666666,\n# \"previousCustomersHelped\" : 16,\n# \"replies\" : 58,\n# \"name\" : \"John Smith\",\n# \"previousHappinessScore\" : 23.529411764705884,\n# \"previousReplies\" : 40,\n# \"user\" : \"1\",\n# \"previousHandleTime\" : 0.0,\n# \"handleTime\" : 78.96\n# } ]\n# }\n```\n\n#### get_company_customers_helped\n\nThe customers helped report provides statistics about how many customers were helped over a given time range. You may optionally specify two time ranges to see how the number of customers helped changed between the two ranges.\n\nMaps to [Company Customers Helped](https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-customers-helped/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_company_customers_helped\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"customers\\\":58}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"customers\\\":69}]}\"\n```\n\n#### get_company_drilldown\n\nThis report is similar to the Company Report, but instead of returning statistics about the company, it drills down and returns the conversation data that makes up the Company Report.\n\nMaps to [Company Drilldown](https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-drilldown/)\n\n| Parameter | Type | Description | Example |\n| :----------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------- |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `page` | `number` | The page number | `page: 2` |\n| `rows` | `number` | Number of result to return per page; defaults to 25; maximum is 50 | `rows: 30` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `range` | `enumeration` | Range valid values are _replies, firstReplyResolved, resolved responseTime, firstResponseTime, handleTime_ **Defaults responseTime** | `range: replies` |\n| `range_id` | `number` | Range ID details, only valid if range is used | `range_id: 2` |\n\n```ruby\nresponse = client.get_company_drilldown\n# =\u003e\n# {\n# \"conversations\" : {\n# \"pages\" : 157,\n# \"page\" : 1,\n# \"count\" : 1561,\n# \"results\" : [ {\n# \"id\" : 583,\n# \"number\" : 12345,\n# \"type\" : \"email\",\n# \"mailboxid\" : 2,\n# \"attachments\" : false,\n# \"subject\" : \"Sample subject\",\n# \"status\" : \"active\",\n# \"threadCount\" : 6,\n# \"preview\" : \"This is a preview...\",\n# \"customerName\" : \"John Smith\",\n# \"customerEmail\" : \"john@example.com\",\n# \"customerIds\" : [ 2 ],\n# \"modifiedAt\" : \"2015-04-24T18:59:49Z\",\n# \"assignedid\" : 4,\n# \"tags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\",\n# \"color\" : \"none\"\n# } ],\n# \"assignedName\" : \"Mary Jones\"\n# } ]\n# }\n# }\n```\n\n### Conversation Reports\n\n#### get_conversations\n\nThe conversations report provides statistics about conversation volume over a given time range. You may optionally specify two time ranges to see how conversation volume changed between the two ranges.\n\nMaps to [Conversations Overall Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-overall)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_conversations\n\n# =\u003e\n# {\n# \"filterTags\" : [ {\n# \"name\" : \"tag a\",\n# \"id\" : 2\n# }, {\n# \"name\" : \"tag b\",\n# \"id\" : 3\n# } ],\n# \"busiestDay\" : {\n# \"day\" : 3,\n# \"hour\" : 0,\n# \"count\" : 411\n# },\n# \"busyTimeStart\" : 11,\n# \"busyTimeEnd\" : 13,\n# \"current\" : {\n# \"startDate\" : \"2015-01-01T00:00:00Z\",\n# \"endDate\" : \"2015-01-31T23:59:59Z\",\n# \"totalConversations\" : 1816,\n# \"conversationsCreated\" : 1698,\n# \"newConversations\" : 1698,\n# \"customers\" : 1302,\n# \"conversationsPerDay\" : 60\n# },\n# \"previous\" : {\n# \"startDate\" : \"2014-01-01T00:00:00Z\",\n# \"endDate\" : \"2014-01-01T23:59:59Z\",\n# \"totalConversations\" : 2080,\n# \"conversationsCreated\" : 1976,\n# \"newConversations\" : 1976,\n# \"customers\" : 1479,\n# \"conversationsPerDay\" : 67\n# },\n# \"deltas\" : {\n# \"newConversations\" : -14.068825910931,\n# \"totalConversations\" : -12.692307692308,\n# \"customers\" : -11.967545638945,\n# \"conversationsCreated\" : -14.068825910931,\n# \"conversationsPerDay\" : -10.44776119403\n# },\n# \"tags\" : {\n# \"count\" : 351,\n# \"top\" : [ {\n# \"id\" : 1,\n# \"count\" : 1465,\n# \"previousCount\" : 1651,\n# \"percent\" : 80.671806167401,\n# \"previousPercent\" : 79.375,\n# \"deltaPercent\" : 1.2968061674009\n# }, {\n# \"name\" : \"tag a\",\n# \"id\" : 2,\n# \"count\" : 51,\n# \"previousCount\" : 63,\n# \"percent\" : 2.8083700440529,\n# \"previousPercent\" : 3.0288461538462,\n# \"deltaPercent\" : -0.22047610979329\n# }, {\n# \"name\" : \"tag b\",\n# \"id\" : 406031,\n# \"count\" : 24,\n# \"previousCount\" : 20,\n# \"percent\" : 1.3215859030837,\n# \"previousPercent\" : 0.96153846153846,\n# \"deltaPercent\" : 0.36004744154524\n# } ]\n# },\n# \"customers\" : {\n# \"count\" : 1816,\n# \"top\" : [ {\n# \"count\" : 31,\n# \"deltaPercent\" : 0.31281768891901,\n# \"id\" : 1,\n# \"name\" : \"John Smith\",\n# \"percent\" : 1.7070484581498,\n# \"previousCount\" : 29,\n# \"previousPercent\" : 1.3942307692308\n# }, {\n# \"count\" : 12,\n# \"deltaPercent\" : -0.10843781768892,\n# \"id\" : 2,\n# \"name\" : \"Mary Jones\",\n# \"percent\" : 0.66079295154185,\n# \"previousCount\" : 16,\n# \"previousPercent\" : 0.76923076923077\n# } ]\n# },\n# \"replies\" : {\n# \"count\" : 109,\n# \"top\" : [ {\n# \"name\" : \"Saved Reply 1\",\n# \"id\" : 1,\n# \"mailboxId\" : 1,\n# \"count\" : 16,\n# \"previousCount\" : 9,\n# \"percent\" : 0.88105726872247,\n# \"previousPercent\" : 0.43269230769231,\n# \"deltaPercent\" : 0.44836496103016\n# }, {\n# \"name\" : \"Saved Reply 2\",\n# \"id\" : 2,\n# \"mailboxId\" : 1,\n# \"count\" : 13,\n# \"previousCount\" : 12,\n# \"percent\" : 0.715859030837,\n# \"previousPercent\" : 0.57692307692308,\n# \"deltaPercent\" : 0.13893595391393\n# } ]\n# },\n# \"workflows\" : {\n# \"count\" : 240,\n# \"top\" : [ {\n# \"name\" : \"Workflow 1\",\n# \"id\" : 1,\n# \"count\" : 90,\n# \"previousCount\" : 82,\n# \"percent\" : 4.9559471365639,\n# \"previousPercent\" : 3.9423076923077,\n# \"deltaPercent\" : 1.0136394442562\n# }, {\n# \"name\" : \"Workflow 2\",\n# \"id\" : 2,\n# \"count\" : 75,\n# \"previousCount\" : 91,\n# \"percent\" : 4.1299559471366,\n# \"previousPercent\" : 4.375,\n# \"deltaPercent\" : -0.24504405286344\n# } ]\n# },\n# \"customFields\" : {\n# \"count\" : 1,\n# \"fields\" : [ {\n# \"id\" : 8,\n# \"name\" : \"Account Type\",\n# \"mailboxId\" : 1234,\n# \"values\" : [ {\n# \"name\" : \"Paying Customer\",\n# \"id\" : 7,\n# \"count\" : 1442,\n# \"percent\" : 55.12232415902141\n# }, {\n# \"name\" : \"Trial Customer\",\n# \"id\" : 11,\n# \"count\" : 273,\n# \"percent\" : 10.435779816513762\n# } ],\n# \"summary\" : {\n# \"total\" : 2616,\n# \"totalAnswered\" : 2241,\n# \"previousTotal\" : null,\n# \"previousTotalAnswered\" : null,\n# \"unansweredDelta\" : 14.3348623853211,\n# \"unansweredPreviousPercent\" : 0,\n# \"unansweredPercent\" : 14.3348623853211\n# }\n# } ]\n# }\n# }\n```\n\n#### get_conversations_new_conversations\n\nThe new conversations report provides a summary of new conversation volume over a given time range.\n\nMaps to [Conversations - New Conversations](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-new)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_conversations_new_conversations\n# =\u003e \"{\\\"current\\\":[{\\\"start\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"count\\\":62}],\\\"previous\\\":[{\\\"start\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"count\\\":69}]}\"\n```\n\n#### get_conversations_channel_volumes\n\nThis report shows conversation volumes split by chat, phone and email channels.\n\nMaps to [All Channels - Volumes by Channel](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-volume-by-channel/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_conversations_channel_volumes\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"chat\\\":0,\\\"email\\\":62,\\\"phone\\\":0}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"chat\\\":0,\\\"email\\\":69,\\\"phone\\\":0}]}\"\n```\n\n#### get_conversations_busiest_times\n\nThe busiest time of day report provides a summary of which days and times had the highest coversation volume. Days/hours are reported using the company’s time zone.\n\nMaps to [Conversations - Busiest Time of Day](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-busy-times/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_conversations_busiest_times\n# =\u003e\n# [ {\n# \"day\" : 1,\n# \"hour\" : 0,\n# \"count\" : 3\n# }, {\n# \"day\" : 1,\n# \"hour\" : 1,\n# \"count\" : 2\n# }, {\n# \"day\" : 7,\n# \"hour\" : 22,\n# \"count\" : 12\n# }, {\n# \"day\" : 7,\n# \"hour\" : 23,\n# \"count\" : 4\n# } ]\n```\n\n#### get_conversations_drilldown\n\nThis report is similar to the Conversations Report, but instead of returning statistics about conversation volume, it drills down and returns the conversation data that makes up the Conversations Report.\n\nMaps to [Conversations - Drilldown](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-drilldown/)\n\n| Parameter | Type | Description | Example |\n| :----------- | :------------ | :----------------------------------------------------------------------------------------------- | :--------------------------------------- |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `page` | `number` | The page number | `page: 2` |\n| `rows` | `number` | Number of result to return per page; defaults to 25; maximum is 50 | `rows: 30` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_conversations_drilldown\n# =\u003e\n# {\n# \"conversations\" : {\n# \"pages\" : 157,\n# \"page\" : 1,\n# \"count\" : 1561,\n# \"results\" : [ {\n# \"id\" : 583,\n# \"number\" : 12345,\n# \"type\" : \"email\",\n# \"mailboxid\" : 2,\n# \"attachments\" : false,\n# \"subject\" : \"Sample subject\",\n# \"status\" : \"active\",\n# \"threadCount\" : 6,\n# \"preview\" : \"This is a preview...\",\n# \"customerName\" : \"John Smith\",\n# \"customerEmail\" : \"john@example.com\",\n# \"customerIds\" : [ 2 ],\n# \"modifiedAt\" : \"2015-04-24T18:59:49Z\",\n# \"assignedid\" : 4,\n# \"tags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\",\n# \"color\" : \"none\"\n# } ],\n# \"assignedName\" : \"Mary Jones\"\n# } ]\n# }\n# }\n```\n\n#### get_conversations_drilldown_by_field\n\nThis report is similar to the Conversations Report, but instead of returning statistics about conversation volume, it drills down and returns the conversation data (by conversation field) that makes up the Conversations Report.\n\nMaps to [Conversations - Drilldown by Field](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-field-drilldown/)\n\n| Parameter | Type | Description | Example |\n| :----------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------- |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `page` | `number` | The page number | `page: 2` |\n| `rows` | `number` | Number of result to return per page; defaults to 25; maximum is 50 | `rows: 30` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `field` | `enumeration` | Field to drill down; valid values: _tagid (for tags), replyid (for saved replies), workflowid (for workflows), customerid (for most active customers)_ **Defaults to customerid** | `field: customerid` |\n| `field_id` | `number` | The identifier on which to drill down; can be an identifier representing a tag, saved reply, workflow, or customer | `field_id: 2` |\n\n```ruby\nresponse = client.get_conversations_drilldown_by_field\n# =\u003e\n# {\n# \"conversations\" : {\n# \"pages\" : 157,\n# \"page\" : 1,\n# \"count\" : 1561,\n# \"results\" : [ {\n# \"id\" : 583,\n# \"number\" : 12345,\n# \"type\" : \"email\",\n# \"mailboxid\" : 2,\n# \"attachments\" : false,\n# \"subject\" : \"Sample subject\",\n# \"status\" : \"active\",\n# \"threadCount\" : 6,\n# \"preview\" : \"This is a preview...\",\n# \"customerName\" : \"John Smith\",\n# \"customerEmail\" : \"john@example.com\",\n# \"customerIds\" : [ 2 ],\n# \"modifiedAt\" : \"2015-04-24T18:59:49Z\",\n# \"assignedid\" : 4,\n# \"tags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\",\n# \"color\" : \"none\"\n# } ],\n# \"assignedName\" : \"Mary Jones\"\n# } ]\n# }\n# }\n```\n\n#### get_conversations_new_conversations_drilldown\n\nThis report is similar to the New Conversations Report, but instead of returning statistics about new conversation volume, it drills down and returns the actual new conversations that makes up the New Conversations Report.\n\nMaps to [Conversations - New Conversations Drilldown](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-new-drilldown/)\n\n| Parameter | Type | Description | Example |\n| :----------- | :------------ | :----------------------------------------------------------------------------------------------- | :--------------------------------------- |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `page` | `number` | The page number | `page: 2` |\n| `rows` | `number` | Number of result to return per page; defaults to 25; maximum is 50 | `rows: 30` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_conversations_new_conversations_drilldown\n# =\u003e\n# {\n# \"conversations\" : {\n# \"pages\" : 157,\n# \"page\" : 1,\n# \"count\" : 1561,\n# \"results\" : [ {\n# \"id\" : 583,\n# \"number\" : 12345,\n# \"type\" : \"email\",\n# \"mailboxid\" : 2,\n# \"attachments\" : false,\n# \"subject\" : \"Sample subject\",\n# \"status\" : \"active\",\n# \"threadCount\" : 6,\n# \"preview\" : \"This is a preview...\",\n# \"customerName\" : \"John Smith\",\n# \"customerEmail\" : \"john@example.com\",\n# \"customerIds\" : [ 2 ],\n# \"modifiedAt\" : \"2015-04-24T18:59:49Z\",\n# \"assignedid\" : 4,\n# \"tags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\",\n# \"color\" : \"none\"\n# } ],\n# \"assignedName\" : \"Mary Jones\"\n# } ]\n# }\n# }\n```\n\n#### get_conversations_received_message_stats\n\nThe received messages report provides a summary of the volume of received messages over a given time range. Only messages from customers are counted.\n\nMaps to [Conversations - Received Messages Statistics](https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-received-messages/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_conversations_received_message_stats\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"messages\\\":126}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"messages\\\":146}]}\"\n```\n\n### Doc Reports\n\n#### get_docs\n\nThe Docs report provides statistics about Docs usage (searches, top articles, etc.) over a given time range. You may optionally specify two time ranges to see how usage changed between the two ranges.\n\nMaps to [Docs Overall Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/docs/reports-docs-overall/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `sites` | `string` | List of comma separated docs site IDs | `sites: 5215163545667acd25394b5c or sites:5215163545667acd25394b5c,5214c77c45667acd25394b51` |\n\n```ruby\nresponse = client.get_docs\n# =\u003e\n# {\n# \"current\" : {\n# \"visitors\" : 10723,\n# \"browseAction\" : 88.94575230296827,\n# \"sentAnEmailResult\" : 0.3450526904784109,\n# \"foundAnAnswerResult\" : 72.93667816842301,\n# \"searchAction\" : 11.05424769703173,\n# \"failedResult\" : 26.71826914109857,\n# \"docsViewedPerVisit\" : 0.9329443525211182\n# },\n# \"popularSearches\" : [ {\n# \"count\" : 22,\n# \"id\" : \"pricing\",\n# \"results\" : 4\n# }, {\n# \"count\" : 21,\n# \"id\" : \"beacon\",\n# \"results\" : 9\n# } ],\n# \"failedSearches\" : [ {\n# \"count\" : 2,\n# \"id\" : \"knowlege\"\n# }, {\n# \"count\" : 1,\n# \"id\" : \"auto-advance\"\n# } ],\n# \"topArticles\" : [ {\n# \"count\" : 2295,\n# \"name\" : \"Email commands \",\n# \"siteId\" : \"52244cc53e3e9bd67a3dc68c\",\n# \"id\" : \"524db929e400c2199a391f39\",\n# \"collectionId\" : \"524491b4e4b0145597daf4e4\"\n# } ],\n# \"topCategories\" : [ {\n# \"count\" : 1153,\n# \"name\" : \"Productivity\",\n# \"siteId\" : \"52444cc53e3e9bd67a3dc28c\",\n# \"id\" : \"52b5a3b6e4b0a3b4e5ec64d3\",\n# \"articles\" : 20\n# }, {\n# \"count\" : 790,\n# \"name\" : \"Copying Email to Help Scout\",\n# \"siteId\" : \"52444cc53e3e9bd67b3dc68c\",\n# \"id\" : \"52548414e4b0772073dac6d0\",\n# \"articles\" : 17\n# } ],\n# \"deltas\" : {\n# \"failedResult\" : 2.4021178109331593,\n# \"docsViewedPerVisit\" : 2.561943903720043,\n# \"foundAnAnswerResult\" : -2.7056392137487535,\n# \"visitors\" : -14.622392395035643,\n# \"browseAction\" : -2.154856275773497,\n# \"searchAction\" : 2.1548562757735183,\n# \"sentAnEmailResult\" : 0.30352140281560414\n# }\n# }\n```\n\n### Happiness Reports\n\n#### get_happiness\n\nThe happiness report provides information about how many Great, Okay, and Not Good ratings your company received for each period in a specified time range. You may optionally specify two time ranges to see how happiness ratings changed between the two time ranges.\n\nMaps to [Happiness Overall Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/happiness/reports-happiness-overall/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_happiness\n# =\u003e\n# {\n# \"current\" : {\n# \"ratingsPercent\" : 35.77981651376147,\n# \"okay\" : 30.909090909090907,\n# \"great\" : 37.27272727272727,\n# \"happinessScore\" : 5.454545454545457,\n# \"okayCount\" : 34,\n# \"totalCustomersWithRatings\" : 39,\n# \"notGoodCount\" : 35,\n# \"ratingsCount\" : 110,\n# \"notGood\" : 31.818181818181817,\n# \"greatCount\" : 41,\n# \"totalCustomers\" : 109\n# },\n# \"previous\" : {\n# \"ratingsPercent\" : 32.03047366677708,\n# \"great\" : 31.65735567970205,\n# \"okay\" : 36.49906890130354,\n# \"happinessScore\" : -0.1862197392923619,\n# \"okayCount\" : 392,\n# \"totalCustomersWithRatings\" : 967,\n# \"notGoodCount\" : 342,\n# \"ratingsCount\" : 1074,\n# \"notGood\" : 31.843575418994412,\n# \"greatCount\" : 340,\n# \"totalCustomers\" : 3019\n# },\n# \"deltas\" : {\n# \"okay\" : -5.589977992212631,\n# \"great\" : 5.615371593025223,\n# \"okayCount\" : -91.3265306122449,\n# \"happinessScore\" : 5.640765193837819,\n# \"notGoodCount\" : -89.76608187134502,\n# \"notGood\" : -0.02539360081259545,\n# \"greatCount\" : -87.94117647058823\n# }\n# }\n```\n\n#### get_happiness_ratings\n\nThe happiness ratings report provides a company’s ratings for over a specified time range.\n\nMaps to [Happiness Ratings Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/happiness/reports-happiness-ratings/)\n\n| Parameter | Type | Description | Example |\n| :----------- | :------------ | :----------------------------------------------------------------------------------------------- | :--------------------------------------- |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `page` | `number` | The page number | `page: 2` |\n| `sort_field` | `enumeration` | Must be one of _number, modifiedAt, rating_ **Defaults to rating** | `sort_field: rating` |\n| `sort_order` | `enumeration` | Must be one of _ASC or DESC_ **Defaults to ASC** | `sort_order: ASC` |\n| `rating` | `enumeration` | Rating to filter on, valid values are: _great, ok, all, not-good_ | `rating: great` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n\n```ruby\nresponse = client.get_happiness_ratings\n# =\u003e\n# {\n# \"results\" : [ {\n# \"number\" : 222043,\n# \"threadid\" : 1169815634,\n# \"threadCreatedAt\" : \"2017-09-15T11:57:14Z\",\n# \"id\" : 432207336,\n# \"type\" : \"email\",\n# \"ratingId\" : 1,\n# \"ratingCustomerId\" : 121198824,\n# \"ratingComments\" : \"Thanks for the clear reply, Amanda!\",\n# \"ratingCreatedAt\" : \"2017-09-15T12:26:53Z\",\n# \"ratingCustomerName\" : \"Alexander the Great\",\n# \"ratingUserId\" : 69013,\n# \"ratingUserName\" : \"Amanda Herrington\"\n# }, {\n# \"number\" : 226983,\n# \"threadid\" : 1169298612,\n# \"threadCreatedAt\" : \"2017-09-15T03:52:30Z\",\n# \"id\" : 432031326,\n# \"type\" : \"email\",\n# \"ratingId\" : 1,\n# \"ratingCustomerId\" : 121972376,\n# \"ratingComments\" : \"Super helpful!\",\n# \"ratingCreatedAt\" : \"2017-09-15T14:54:27Z\",\n# \"ratingCustomerName\" : \"Mikey Mikelson\",\n# \"ratingUserId\" : 76859,\n# \"ratingUserName\" : \"Shawna Herring\"\n# } ],\n# \"page\" : 1,\n# \"count\" : 100,\n# \"pages\" : 2\n# }\n```\n\n### Productivity Reports\n\n#### get_productivity\n\nThe productivity report provides a snapshot of productivity over a given time range. You may optionally specify two time ranges to see how productivity changed between the two ranges.\n\nIf you would like to see the conversation data that make up this report, please use the Company Drilldown endpoint\n\nMaps to [Productivity Overall Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-overall/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n\n```ruby\nresponse = client.get_productivity\n# =\u003e\n# {\n# \"filterTags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\"\n# } ],\n# \"current\" : {\n# \"startDate\" : \"2015-01-01T00:00:00Z\",\n# \"endDate\" : \"2015-01-31T23:59:59Z\",\n# \"totalConversations\" : 1,\n# \"resolutionTime\" : 2278004.0,\n# \"repliesToResolve\" : 2.0,\n# \"responseTime\" : 2278004,\n# \"firstResponseTime\" : 2278004,\n# \"resolved\" : 1,\n# \"resolvedOnFirstReply\" : 0,\n# \"closed\" : 94,\n# \"repliesSent\" : 62,\n# \"handleTime\" : 6,\n# \"percentResolvedOnFirstReply\" : 0.0\n# },\n# \"previous\" : {\n# \"startDate\" : \"2014-01-01T00:00:00Z\",\n# \"endDate\" : \"2014-01-31T23:59:59Z\",\n# \"totalConversations\" : 14,\n# \"resolutionTime\" : 6531211.714285715,\n# \"repliesToResolve\" : 2.2142857142857144,\n# \"responseTime\" : 4850412,\n# \"firstResponseTime\" : 5138913,\n# \"resolved\" : 14,\n# \"resolvedOnFirstReply\" : 5,\n# \"closed\" : 49,\n# \"repliesSent\" : 636,\n# \"handleTime\" : 0,\n# \"percentResolvedOnFirstReply\" : 0.35714285714285715\n# },\n# \"deltas\" : {\n# \"totalConversations\" : -92.85714285714286,\n# \"repliesSent\" : -90.25157232704403,\n# \"firstResponseTime\" : -55.67148149813006,\n# \"resolved\" : -92.85714285714286,\n# \"repliesToResolve\" : -9.677419354838712,\n# \"closed\" : 91.83673469387755,\n# \"resolvedOnFirstReply\" : -100.0,\n# \"responseTime\" : -53.03483497896673,\n# \"handleTime\" : 0.0,\n# \"resolutionTime\" : -65.12126539984419\n# },\n# \"responseTime\" : {\n# \"count\" : 1,\n# \"previousCount\" : 14,\n# \"ranges\" : [ {\n# \"id\" : 10,\n# \"count\" : 1,\n# \"previousCount\" : 12,\n# \"percent\" : 100.0,\n# \"previousPercent\" : 85.71428571428571\n# } ]\n# },\n# \"handleTime\" : {\n# \"count\" : 1,\n# \"previousCount\" : 14,\n# \"ranges\" : [ {\n# \"id\" : 1,\n# \"count\" : 1,\n# \"previousCount\" : 14,\n# \"percent\" : 100.0,\n# \"previousPercent\" : 100.0\n# } ]\n# },\n# \"firstResponseTime\" : {\n# \"count\" : 1,\n# \"previousCount\" : 14,\n# \"ranges\" : [ {\n# \"id\" : 10,\n# \"count\" : 1,\n# \"previousCount\" : 12,\n# \"percent\" : 100.0,\n# \"previousPercent\" : 85.71428571428571\n# } ]\n# },\n# \"repliesToResolve\" : {\n# \"count\" : 1,\n# \"previousCount\" : 14,\n# \"ranges\" : [ {\n# \"id\" : 2,\n# \"count\" : 1,\n# \"previousCount\" : 4,\n# \"percent\" : 100.0,\n# \"previousPercent\" : 28.57142857142857,\n# \"resolutionTime\" : 2278004\n# } ]\n# }\n# }\n```\n\n#### get_productivity_first_response_time\n\nThis report provides average first response times for each period in a specified time range. You may optionally specify two time ranges to see how first response time changed between the two ranges.\n\nMaps to [Productivity - First Response Time](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-first-response-time/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_productivity_first_response_time\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"time\\\":77134}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"time\\\":160951}]}\"\n```\n\n#### get_productivity_replies_sent\n\nThis report provides the number of replies sent for each period in a specified time range. You may optionally specify two time ranges to see how the number of replies sent changed between the two ranges.\n\nMaps to [Productivity - Replies Sent](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-replies-sent/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_productivity_replies_sent\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"replies\\\":86}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"replies\\\":109}]}\"\n```\n\n#### get_productivity_resolution_time\n\nThis report provides average resolution times for each period in a specified time range. You may optionally specify two time ranges to see how average resolution time changed between the two ranges.\n\nMaps to [Productivity - Resolution Time](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-resolution-time/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_productivity_resolution_time\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"time\\\":423588}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"time\\\":642356}]}\"\n```\n\n#### get_productivity_resolved\n\nThis report provides the number of resolved conversations for each period in a specified time range. You may optionally specify two time ranges to see how the number of resolved conversations changed between the two ranges.\n\nMaps to [Productivity - Resolved](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-resolved/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_productivity_resolved\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"resolved\\\":49}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"resolved\\\":47}]}\"\n```\n\n#### get_productivity_response_time\n\nThis report provides average response times for each period in a specified time range. You may optionally specify two time ranges to see how response time changed between the two ranges.\n\nMaps to [Productivity - Response Time](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-respose-time/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_productivity_response_time\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"time\\\":82731}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"time\\\":115673}]}\"\n```\n\n### User Report\n\n#### get_user\n\nPlease note that if a team ID is used instead of an user ID, the report calculates summary data for all team members.\n\nThe report provides a snapshot of a user or team activity over a specified time range. You may optionally specify two time ranges to see how activity changed between the two ranges.\n\nMaps to [User/Team Overall Report](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n\n```ruby\nresponse = client.get_user\n# =\u003e\n# {\n# \"filterTags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\"\n# } ],\n# \"user\" : {\n# \"id\" : 4,\n# \"hasPhoto\" : true,\n# \"createdAt\" : \"2010-09-03T15:55:48Z\",\n# \"name\" : \"John Smith\",\n# \"totalCustomersHelped\" : 6580,\n# \"photoUrl\" : \"http://example.com/pic.jpg\"\n# },\n# \"current\" : {\n# \"startDate\" : \"2015-01-01T00:00:00Z\",\n# \"endDate\" : \"2015-01-31T23:59:59Z\",\n# \"totalDays\" : 30,\n# \"resolved\" : 1,\n# \"conversationsCreated\" : 15,\n# \"closed\" : 3,\n# \"totalReplies\" : 58,\n# \"resolvedOnFirstReply\" : 0,\n# \"percentResolvedOnFirstReply\" : 0.0,\n# \"repliesToResolve\" : 2.0,\n# \"handleTime\" : 78.96,\n# \"happinessScore\" : 66.66666666666666,\n# \"responseTime\" : 2278004,\n# \"resolutionTime\" : 2278004.0,\n# \"repliesPerDay\" : 1.9333333333333333,\n# \"customersHelped\" : 26,\n# \"totalConversations\" : 19,\n# \"conversationsPerDay\" : 0.6333333333333333,\n# \"busiestDay\" : 5\n# },\n# \"previous\" : {\n# \"startDate\" : \"2014-01-01T00:00:00Z\",\n# \"endDate\" : \"2014-01-31T23:59:59Z\",\n# \"totalDays\" : 30,\n# \"resolved\" : 12,\n# \"conversationsCreated\" : 2,\n# \"closed\" : 33,\n# \"totalReplies\" : 40,\n# \"resolvedOnFirstReply\" : 4,\n# \"percentResolvedOnFirstReply\" : 0.3333333333333333,\n# \"repliesToResolve\" : 2.1666666666666665,\n# \"handleTime\" : 0.0,\n# \"happinessScore\" : 23.529411764705884,\n# \"responseTime\" : 2357169,\n# \"resolutionTime\" : 4318101.5,\n# \"repliesPerDay\" : 1.3333333333333333,\n# \"customersHelped\" : 16,\n# \"totalConversations\" : 42,\n# \"conversationsPerDay\" : 0.4\n# },\n# \"deltas\" : {\n# \"totalConversations\" : -54.761904761904766,\n# \"customersHelped\" : 62.5,\n# \"happinessScore\" : 43.13725490196077,\n# \"repliesPerDay\" : 45.000000000000014,\n# \"resolvedOnFirstReply\" : -100.0,\n# \"handleTime\" : 0.0,\n# \"conversationsPerDay\" : 58.33333333333333,\n# \"resolved\" : -91.66666666666666,\n# \"repliesToResolve\" : -7.692307692307687,\n# \"activeConversations\" : -54.761904761904766,\n# \"totalReplies\" : 44.99999999999999,\n# \"closed\" : -90.9090909090909,\n# \"responseTime\" : -3.3584779029420475,\n# \"resolutionTime\" : -47.245241919394445,\n# \"conversationsCreated\" : 650.0\n# }\n# }\n```\n\n#### get_user_conversation_history\n\nThe conversation history report provides details about a user’s conversations for over a specified time range.\n\nMaps to [User Conversation History](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-conversation-history/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `office_hours` | `boolean` | Whether to take office hours into consideration in the report (defaults to false); office hours must be enabled if true is passed, otherwise the default of false will be used | `office_hours: true` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n| `status` | `enumeration` | Conversation status, one of _active, pending, closed_ | `user: 1` |\n| `page` | `number` | The page number | `page: 2` |\n| `sort_field` | `enumeration` | Must be one of _number, modifiedAt, rating_ **Defaults to number** | `sort_field: rating` |\n| `sort_order` | `enumeration` | Must be one of _ASC or DESC_ **Defaults to ASC** | `sort_order: ASC` |\n\n```ruby\nresponse = client.get_user_conversation_history\n# =\u003e\n# {\n# \"results\" : [ {\n# \"id\" : 416351186,\n# \"number\" : 222002,\n# \"customers\" : [ {\n# \"id\" : 138946703,\n# \"name\" : \"Peter Peters\"\n# } ],\n# \"avgHandleTime\" : 279,\n# \"firstResponseTime\" : 1878,\n# \"repliesSent\" : 1,\n# \"responseTime\" : 1878,\n# \"resolveTime\" : 1878\n# }, {\n# \"id\" : 4845671933,\n# \"number\" : 221955,\n# \"customers\" : [ {\n# \"id\" : 137966680,\n# \"name\" : \"Alex Ballena\"\n# } ],\n# \"avgHandleTime\" : 154,\n# \"firstResponseTime\" : 8307,\n# \"repliesSent\" : 1,\n# \"responseTime\" : 8307,\n# \"resolveTime\" : 8307\n# } ],\n# \"page\" : 1,\n# \"count\" : 2303,\n# \"pages\" : 20\n# }\n```\n\n#### get_user_customers_helped\n\nThis reports provides the number of customers a user helped for each period in a specified time range. You may optionally specify two time ranges to see how the number of customers helped changed between the two time ranges.\n\nMaps to [User Customers Helped](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-customer-helped/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_user_customers_helped\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"customers\\\":17}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"customers\\\":16}]}\"\n```\n\n#### get_user_drilldown\n\nThis report is similar to the User Report, but instead of returning statistics about users, it drills down and returns the conversation data that makes up the User Report.\n\nMaps to [User Drill-down](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-drilldown/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n| `page` | `number` | The page number | `page: 2` |\n| `rows` | `number` | Number of result to return per page; defaults to 25; maximum is 50 | `rows: 30` |\n\n```ruby\nresponse = client.get_user_drilldown\n# =\u003e\n# {\n# \"conversations\" : {\n# \"results\" : [ {\n# \"id\" : 430221821,\n# \"number\" : 226358,\n# \"type\" : \"email\",\n# \"mailboxid\" : 85,\n# \"attachments\" : false,\n# \"subject\" : \"Folder Not Appearing\",\n# \"status\" : \"active\",\n# \"threadCount\" : 3,\n# \"preview\" : \"Hi Reginald, We actually need this workflow to run on the following condition\",\n# \"customerName\" : \"Owen Freheim\",\n# \"modifiedAt\" : \"2017-09-12T11:22:11Z\",\n# \"assignedid\" : 0,\n# \"waitingSince\" : \"2017-09-12T11:22:11Z\",\n# \"waitingSinceType\" : 2,\n# \"tags\" : [ {\n# \"id\" : 1277761,\n# \"name\" : \"folder-refresh\",\n# \"color\" : \"none\"\n# } ]\n# }, {\n# \"id\" : 430120638,\n# \"number\" : 226333,\n# \"type\" : \"email\",\n# \"mailboxid\" : 85,\n# \"attachments\" : true,\n# \"subject\" : \"Troubles with water level\",\n# \"status\" : \"active\",\n# \"threadCount\" : 4,\n# \"preview\" : \"Hey there seems to be an issue with the following levels...\",\n# \"customerName\" : \"Water service\",\n# \"modifiedAt\" : \"2017-09-12T11:23:06Z\",\n# \"assignedid\" : 0,\n# \"waitingSince\" : \"2017-09-12T11:21:50Z\",\n# \"waitingSinceType\" : 2,\n# \"tags\" : [ ]\n# } ],\n# \"page\" : 1,\n# \"count\" : 101,\n# \"pages\" : 2\n# }\n# }\n```\n\n#### get_user_happiness\n\nThe happiness report provides information about how many Great, Okay, and Not Good ratings a user received for each period in a specified time range. You may optionally specify two time ranges to see how happiness ratings changed between the two time ranges.\n\nMaps to [User Happiness](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-happiness/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n\n```ruby\nresponse = client.get_user_happiness\n# =\u003e\n# {\n# \"filterTags\" : [ {\n# \"id\" : 123,\n# \"name\" : \"sample-tag\"\n# } ],\n# \"current\" : {\n# \"ratingsPercent\" : 35.77981651376147,\n# \"okay\" : 30.909090909090907,\n# \"great\" : 37.27272727272727,\n# \"happinessScore\" : 5.454545454545457,\n# \"okayCount\" : 34,\n# \"totalCustomersWithRatings\" : 39,\n# \"notGoodCount\" : 35,\n# \"ratingsCount\" : 110,\n# \"notGood\" : 31.818181818181817,\n# \"greatCount\" : 41,\n# \"totalCustomers\" : 109\n# },\n# \"previous\" : {\n# \"ratingsPercent\" : 32.03047366677708,\n# \"great\" : 31.65735567970205,\n# \"okay\" : 36.49906890130354,\n# \"happinessScore\" : -0.1862197392923619,\n# \"okayCount\" : 392,\n# \"totalCustomersWithRatings\" : 967,\n# \"notGoodCount\" : 342,\n# \"ratingsCount\" : 1074,\n# \"notGood\" : 31.843575418994412,\n# \"greatCount\" : 340,\n# \"totalCustomers\" : 3019\n# },\n# \"deltas\" : {\n# \"okay\" : -5.589977992212631,\n# \"great\" : 5.615371593025223,\n# \"okayCount\" : -91.3265306122449,\n# \"happinessScore\" : 5.640765193837819,\n# \"notGoodCount\" : -89.76608187134502,\n# \"notGood\" : -0.02539360081259545,\n# \"greatCount\" : -87.94117647058823\n# }\n# }\n```\n\n#### get_user_happiness_drilldown\n\nThe user ratings report provides a user’s ratings for over a specified time range.\n\nMaps to [User Happiness drilldown](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-happiness-drilldown/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n| `rating` | `enumeration` | Rating to filter on, valid values are: _great, ok, all, not-good_ | `rating: great` |\n| `page` | `number` | The page number | `page: 2` |\n| `sort_field` | `enumeration` | Must be one of _number, modifiedAt, rating_ **Defaults to number** | `sort_field: rating` |\n| `sort_order` | `enumeration` | Must be one of _ASC or DESC_ **Defaults to ASC** | `sort_order: ASC` |\n\n```ruby\nresponse = client.get_user_happiness_drilldown\n# =\u003e\n# {\n# \"results\" : [ {\n# \"number\" : 214705,\n# \"threadid\" : 1149512066,\n# \"threadCreatedAt\" : \"2017-09-02T11:21:42Z\",\n# \"id\" : 424890237,\n# \"type\" : \"email\",\n# \"ratingId\" : 1,\n# \"ratingCustomerId\" : 141147564,\n# \"ratingComments\" : \"Nice work!\",\n# \"ratingCreatedAt\" : \"2017-09-02T11:23:43Z\",\n# \"ratingCustomerName\" : \"david@loans.net\",\n# \"ratingUserId\" : 19,\n# \"ratingUserName\" : \"Denny Matthews\"\n# }, {\n# \"number\" : 224713,\n# \"threadid\" : 1149511394,\n# \"threadCreatedAt\" : \"2017-09-02T11:20:31Z\",\n# \"id\" : 424910211,\n# \"type\" : \"email\",\n# \"ratingId\" : 1,\n# \"ratingCustomerId\" : 79911899,\n# \"ratingComments\" : \"Great job\",\n# \"ratingCreatedAt\" : \"2017-09-02T11:28:47Z\",\n# \"ratingCustomerName\" : \"Robert Johnson\",\n# \"ratingUserId\" : 4,\n# \"ratingUserName\" : \"Robert Swindle\"\n# } ],\n# \"page\" : 1,\n# \"count\" : 165,\n# \"pages\" : 17\n# }\n```\n\n#### get_user_replies\n\nThis reports provides the number of replies a user sent for each period in a specified time range. You may optionally specify two time ranges to see how the number replies changed between the two time ranges.\n\nMaps to [User Replies](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-replies/)\n\n| Parameter | Type | Description | Example |\n| :-------------------- | :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------------------ |\n| `start_date` | `utc.iso8601` | Start of the interval **Defaults 1.week.ago.beginning_of_day.utc.iso8601** | `start_date: 2020-03-09T13:30:00Z` |\n| `end_date` | `utc.iso8601` | End of the interval **Defaults DateTime.now.beginning_of_day.utc.iso8601** | `end_date: 2020-03-16T13:30:00Z` |\n| `previous_start_date` | `utc.iso8601` | Start of the previous interval **Defaults 3.weeks.ago.beginning_of_day.utc.iso8601** | `previous_start_date: 2020-02-24T13:30:00Z` |\n| `previous_end_date` | `utc.iso8601` | End of the previous interval **Defaults 2.weeks.ago.beginning_of_day.utc.iso8601** | `previous_end_date: 2020-03-02T13:30:00Z` |\n| `tags` | `number` | List of comma separated ids to filter on tags | `tags:99787 or tags:5666 99787` |\n| `types` | `enumeration` | List of comma separated conversation types to filter on, valid values are _email, chat or phone_ | `types: email or types:chat,email,phone` |\n| `folders` | `number` | List of comma separated folder ids to filter on folders | `folders: 991 or folders: 991,99` |\n| `user` | `number` | User for whom the report is generated **Defaults 1** | `user: 1` |\n| `view_by` | `enumeration` | Represents the resolution at which data is returned; valid values are: _day, week or month_ | `view_by: day` |\n\n```ruby\nresponse = client.get_user_replies\n# =\u003e \"{\\\"current\\\":[{\\\"date\\\":\\\"2020-03-09T13:30:00Z\\\",\\\"replies\\\":24}],\\\"previous\\\":[{\\\"date\\\":\\\"2020-02-24T13:30:00Z\\\",\\\"replies\\\":18}]}\"\n```\n\n#### get_user_resolutions\n\nThis reports provides the number of conversations a user helped resolve for each period in a specified time range. You may optionally specify two time ranges to see how the number of resolved conversations changed between the two time ranges.\n\nMaps to [User Resolutions](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-resolutions/)\n\n| Parame","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjayco%2Fhelpscout-mailbox-v2-reports","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjayco%2Fhelpscout-mailbox-v2-reports","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjayco%2Fhelpscout-mailbox-v2-reports/lists"}