{ "opencollection": "1.0.0", "info": { "name": "Huntress API Reference Accounts Summary Reports API", "version": "1.0.0" }, "items": [ { "info": { "name": "Summary Reports", "type": "folder" }, "items": [ { "info": { "name": "List Summary Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reports", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500." }, { "name": "page_token", "value": "", "type": "query", "description": "Token used to request the next page in paginated results. Defaults to 'null'" }, { "name": "sort_field", "value": "", "type": "query", "description": "Field to sort by. Defaults to 'id'." }, { "name": "sort_direction", "value": "", "type": "query", "description": "Sort direction. Defaults to 'desc'." }, { "name": "period_min", "value": "", "type": "query", "description": "Filter by an ISO-8601 formatted date string that represents the lower bound of the search range for the period date." }, { "name": "period_max", "value": "", "type": "query", "description": "Filter by an ISO-8601 formatted date string that represents the upper bound of the search range for the period date." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by organization ID within Huntress account" }, { "name": "type", "value": "", "type": "query", "description": "Filter by report type. One of monthly_summary, quarterly_summary, yearly_summary" } ] }, "docs": "Shows Summary Reports associated with your account.\n\n**Note:** This endpoint will also return a `pagination` key on the root level. \nPlease refer to the [pagination section](https://api.huntress.io/docs#pagination) within our docs for more information.\n" }, { "info": { "name": "Get Summary Report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Report ID within Huntress account" } ] }, "docs": "Shows details on a single Summary Report associated with your account." } ] } ], "bundled": true }