# Get Spam Trap Hits

Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type.

Endpoint: GET /v1/spamtraps
Version: 0.0.1
Security: basicAuth

## Query parameters:

  - `start` (string, required)
    The start date in UTC (format YYYY-MM-DD) of the timeframe for which you wish to see data.

  - `end` (string, required)
    The end date in UTC (format YYYY-MM-DD) of the timeframe for which you wish to see data.

  - `sortby` (string)
    Acceptable values include date, totals, domain, subject, ip, and from. Defaults to date.

  - `groupby` (string)
    Use this field to group results. Acceptable values include domain, subject, ip, and from.

  - `subject` (string)
    Use this field to filter results by email subject.

  - `domain` (string)
    Use this field to filter results by domain(s).

  - `ip` (string)
    Use this field to filter results by ip(s).

  - `from` (string)
    Use this field to filter results by sender email address.

  - `limit` (integer, required)
    Limits the number of items returned in a request

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.date` (string, required)

  - `items.pristine` (integer, required)

  - `items.recycled` (integer, required)

  - `items.typo` (integer, required)

  - `items.harvested` (integer, required)

  - `items.total` (integer, required)

  - `paging` (object, required)

  - `paging.first` (string, required)

  - `paging.previous` (string, required)

  - `paging.next` (string, required)

## Response 400 fields (application/json):

  - `message` (string, required)