Activité clé/site

Un point de terminaison pour suivre les sites qui utilisent votre clé API Akismet.

https://rest.akismet.com/1.2/key-sites

Tous les paramètres peuvent être transmis via les méthodes GET ou POST.

Paramètres obligatoires

api_key
Votre clé API Akismet. Vous pouvez la trouver sur votre tableau de bord de compte à l’adresse https://akismet.com/account/

Paramètres facultatifs

month
Le mois pour lequel vous souhaitez obtenir le rapport (par exemple, 2022‑09). Par défaut, le mois en cours.

filter
Filtrer les résultats par URL du site ou URL partielle du site.

Par exemple, un filtre « domaine.tld » renverra l’activité de tous les sites avec « domaine.tld » dans leur URL.

format
Le format dans lequel vous souhaitez que les résultats soient renvoyés.

order
La colonne selon laquelle vous souhaitez que les résultats soient triés.

  • total (par défaut) : Nombre total d’appels API (spam + non indésirable).
  • spam : Trier par le nombre de spams détectés.
  • non indésirable : Trier par le nombre de non indésirables autorisés.
  • missed_spam : Trier par le nombre de spams manqués signalés.
  • false_positives : Trier par le nombre de faux positifs signalés.

limit
Le nombre maximum de résultats renvoyés dans le rapport (par défaut : 500).

offset
Le décalage des résultats renvoyés dans le rapport (par défaut : 0).

Exemple en PHP

$data = file_get_contents( 'https://rest.akismet.com/1.2/key-sites?api_key=123YourAPIKey&month=2022-09&format=csv' );
 
var_dump( $data );

Résultats d’exemple (json)

{
    "2022-09":[
        {
            "site":"site6735.domain.tld",
            "api_calls":"2072",
            "spam":"2069",
            "ham":"3",
            "missed_spam":"0",
            "false_positives":"4",
            "is_revoked":false
        },{
            "site":"site4748.domain.tld",
            "api_calls":"1633",
            "spam":"3",
            "ham":"1630",
            "missed_spam":"0",
            "false_positives":"0",
            "is_revoked":true
        }
    ],
    "limit": 10,
    "offset": 0,
    "total": 2
}

Résultats d’exemple (csv)

Sites actifs pour 123YourAPIKey pendant 2022-09 (limite : 10, décalage : 0, total : 4)
Site,Total des appels API,Spam,Non indésirable,Spam manqué,Faux positifs,Révoqué
site6735.domain.tld,14446,33,13,0,9,false
site3026.domain.tld,8677,101,6,0,0,false
site3737.domain.tld,4230,65,5,2,0,true
site5653.domain.tld,2921,30,1,2,6,false

Clés des résultats

site
Le nom d’hôte du site interrogeant l’API avec votre clé API.

api_calls
Le nombre total d’appels API (spam + non indésirable) effectués par le site au cours du mois interrogé.

spam
Le nombre de fois où Akismet a renvoyé true pour le spam au cours du mois interrogé.

non indésirable
Le nombre de fois où Akismet a renvoyé false pour le spam au cours du mois interrogé.

missed_spam
Le nombre de rapports de spam manqués soumis par le site au cours du mois interrogé.

false_positives
Le nombre de rapports de faux positifs soumis par le site au cours du mois interrogé.

is_revoked
Indique si le site a été révoqué de l’utilisation de votre clé API ou non.

limit
Le nombre maximum de résultats renvoyés dans le rapport. Peut être défini à l’aide du paramètre limit.

offset
Le décalage des résultats renvoyés dans le rapport. Peut être défini à l’aide du paramètre offset.

total
Le nombre total de sites utilisant la clé API au cours du mois interrogé.

Nous sommes là pour vous aider

Si vous êtes bloqué ou avez besoin d’aide pour résoudre un problème, n’hésitez pas à nous contacter.