Activities - Activities



Endpoint

GET /v1.1/activities

Description

Parameters
required *

apiKey *  string Your API access key
brandid  integer Filter to segments for a specific brand
segmentid  integer ID of the segment to filter by
isactive  boolean Show only enabled activities (default 1)
orderby  string Order the results. Accepts the arguments CREATED or ID, plus ASC and DESC eg. orderBy=CREATED+DESC
excludebasicsocial  boolean Set to 1 to exclude your default Basic Social Listening segment
paid_only  boolean Filter to users who have a paid service attached eg. Spotify Premium

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/activities?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/activities?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p", 
	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/activities?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"

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/activities?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

[
{
"Name": "Watch the Enterprise launch on YouTube",
"ID": 222,
"Service": "Custom",
"Active": 1,
"Score": "1",
"StartDate": "2362-10-04 09:00:00",
"EndDate": "2362-10-05 09:00:00",
"Template": {
"data": [
{
"Parameter": "WatchCount",
"Type": "Integer",
"Label": "Watch Count"
}
]
},
"SegmentName": "Launching the new Enterprise",
"BrandName": "Starfleet",
"BrandID": "1701"
},
{
"Name": "Followed a playlist by Commander Data Violin Sessions on Spotify",
"ID": 333,
"Service": "Spotify",
"Active": 1,
"Score": "4",
"StartDate": "2365-01-30 09:00:00",
"EndDate": "2365-03-30 09:00:00",
"Template": {
"data": [
{
"Parameter": "FollowerCount",
"Label": "Follower Count",
"Type": "PlainText",
"Value": "5"
}
]
},
"SegmentName": "Basic Social Listening",
"BrandName": "Commander Data Violin Sessions",
"BrandID": "2345"
},
{
"Name": "Liked a post by Starfleet on Tumblr",
"ID": 444,
"Service": "Tumblr",
"Active": 1,
"Score": "1",
"StartDate": "2361-01-30 09:00:00",
"EndDate": null,
"Template": {
"data": [
{
"Parameter": "Brand",
"Label": "Available Brands",
"Lookup": "TumblrID",
"Value": "Starfleet"
}
]
},
"SegmentName": "Basic Social Listening",
"BrandName": "Starfleet",
"BrandID": "1701"
},
{
"Name": "Followed Starfleet on Twitter",
"ID": 555,
"Service": "Twitter",
"Active": 1,
"Score": "1",
"StartDate": "2360-01-01 12:00:00",
"EndDate": "2360-01-31 12:00:00",
"Template": null,
"SegmentName": "Basic Social Listening",
"BrandName": "Starfleet",
"BrandID": "1701"
}
]