key-usage

Keep track of the sites that are using your Akismet API key

Lists sites using your API key along with stats on their API usage.

get/1.2/key-sites

Request

  • Base URL: https://rest.akismet.com
  • URL: https://rest.akismet.com/1.2/key-sites
  • Auth: none declared

Query parameters

api_keystring required

The Akismet API key for authorization.

monthstring

The month for which you would like to get the report (in YYYY-MM format). Defaults to the current month.

filterstring

Filter results by site URL or partial site URL.

format'json' | 'csv'

The format in which you would like the results to be returned. Allowed values are json (default) and csv. Defaults to json.

order'total' | 'spam' | 'ham' | 'missed_spam' | 'false_positives'

The column by which you would like the results to be sorted. Defaults to total.

limitinteger

The maximum number of results returned in the report (defaults to 500).

offsetinteger

The offset of the results returned in the report (defaults to 0).

Response

Key sites response.

object required

Example response

{
  "2023-07": [
    {
      "site": "example.com",
      "api_calls": "1000",
      "spam": "434",
      "ham": "544",
      "missed_spam": "5",
      "false_positives": "2",
      "is_revoked": false
    },
    {
      "site": "example.org",
      "api_calls": "250",
      "spam": "150",
      "ham": "100",
      "missed_spam": "0",
      "false_positives": "1",
      "is_revoked": false
    }
  ],
  "limit": 500,
  "offset": 0,
  "total": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.