phpAx / Braze Endpoints / Monthly Active Users for Last 30 Days
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateInt('length',7);
$queryParams->UpdateString('ending_at','2018-06-28T23:59:59-05:00');
$queryParams->UpdateString('app_id','{{app_identifier}}');
// Adds the "Authorization: Bearer {{api_key}}" header.
$http->AuthToken = '{{api_key}}';
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://rest.iad-01.braze.com/kpi/mau/data_series',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";
?>
Curl Command
curl -G -d "length=7"
-d "ending_at=2018-06-28T23%3A59%3A59-05%3A00"
-d "app_id=%7B%7Bapp_identifier%7D%7D"
-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/kpi/mau/data_series
Postman Collection Item JSON
{
"name": "Monthly Active Users for Last 30 Days",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"url": {
"raw": "https://{{instance_url}}/kpi/mau/data_series?length=7&ending_at=2018-06-28T23:59:59-05:00&app_id={{app_identifier}}",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"kpi",
"mau",
"data_series"
],
"query": [
{
"key": "length",
"value": "7",
"description": "(Required) Integer\n\nMax number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive"
},
{
"key": "ending_at",
"value": "2018-06-28T23:59:59-05:00",
"description": "(Optional) DateTime (ISO 8601 string)\n\nPoint in time when the data series should end - defaults to time of the request"
},
{
"key": "app_id",
"value": "{{app_identifier}}",
"description": "(Optional) String\n\nApp API identifier; if excluded, results for all apps in app group will be returned"
}
]
},
"description": "This endpoint allows you to retrieve a daily series of the total number of unique active users over a 30-day rolling window.\n\n## Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"message\": (required, string) the status of the export, returns 'success' when completed without errors,\n \"data\" : [\n {\n \"time\" : (string) date as ISO 8601 date,\n \"mau\" : (int)\n },\n ...\n ]\n}\n```"
},
"response": [
]
}