Brands - Segment Stats



Endpoint

GET /v1.1/brand/[BrandID]/stats/segment

Description

Obtain an all-time overall total of members and activities for the segment. May be filtered per activity.

Parameters
required *

apiKey *  string Your API access key
[brandID] *  integer Filter to user actions and score for a specific brand
segmentid *  integer Filter to overall members and actions for specific segment
activityid  integer Filter to overall members and actions for specific segment activity
optedin  boolean Value of 1 will only show members who have been opted into this campaign (via optin endpoint call)

Sign in with your developer account to use the console, or sign up here

Example Request

curl -v -X GET "https://api.theappreciationengine.com/v1.1/brand/1234/stats/segment?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/brand/1234/stats/segment?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321", 
	CURLOPT_RETURNTRANSFER => true, 
	CURLOPT_ENCODING => "", 
	CURLOPT_MAXREDIRS => 10, 
	CURLOPT_TIMEOUT => 0, 
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, 
	CURLOPT_CUSTOMREQUEST => "GET", 
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://api.theappreciationengine.com/v1.1/brand/1234/stats/segment?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321"

headers = {}
payload = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text.encode('utf8'))
var request = require('request');
var options = {
	'method': 'GET',
	'url': 'https://api.theappreciationengine.com/v1.1/brand/1234/stats/segment?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"metrics": {
"activities": "3000",
"members": "600"
}
}