REST API v3: GET destination/message statistics (Marketing Suite)

Je kunt de statistieken van een Marketing Suite destination opvragen door een HTTP GET request te sturen naar de volgende URL:

https://api.copernica.com/v3/ms/destination/$id/statistics?access_token=xxxx

Hier moet $id vervangen worden door de ID van de destination.

Let op: De termen 'destination' en 'message' kunnen uitwisselbaar gebruikt worden, ook in de voorbeeldcode.

Parameters

Je kunt met de parameters van deze methode instellen voor welke periode je de statistieken op wilt halen. De volgende parameters zijn beschikbaar voor de methode:

  • begintime: De starttijd voor de statistieken (in YYYY-MM-DD HH:MM:SS formaat).
  • endtime: De eindtijd voor de statistieken (in YYYY-MM-DD HH:MM:SS formaat).

Teruggegeven velden

Het JSON object bevat de volgende velden:

  • ID: ID van de statistieken voor deze destination.
  • abuses: Array met het veld 'total' voor het aantal abuses.
  • clicks: Array met de velden 'total' en 'unique' voor het aantal kliks en het aantal unieke kliks respectievelijk.
  • deliveries: Array met het veld 'total' voor het aantal deliveries.
  • errors: Array met het veld 'total' voor het aantal errors.
  • impressions: Array met de velden 'total' en 'unique' voor het aantal impressies en het aantal unieke impressies respectievelijk.
  • retries: Array met het veld 'total' voor het aantal retries.
  • unsubscribes: Array met het veld 'total' en 'unique' voor het aantal unsubscribes.

Voorbeeld

Hieronder vind je een voorbeeld van zo'n JSON object:

{  
   "ID":"735929",
   "abuses":{  
      "total":0
   },
   "clicks":{  
      "total":3,
      "unique":2
   },
   "deliveries":{  
      "total":0
   },
   "errors":{  
      "total":1
   },
   "impressions":{  
      "total":4
   },
   "retries":{  
      "total":0
   },
   "unsubscribes":{  
      "total":3,
      "unique":2
   }
}

PHP voorbeeld

Het volgende script demonstreert hoe je deze API methode kunt gebruiken:

// vereiste scripts
require_once('copernica_rest_api.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 3);

// stel de periode voor de statistieken in
$data = array(
    'begintime' =>  "2020-01-01 00:00:00",
    'endtime'   =>  "2020-02-01 00:00:00"
);

// voer het verzoek uit
print_r($api->get("ms/destination/{$destinationID}/statistics/", $data));

Dit voorbeeld vereist de REST API klasse.

Meer informatie