Activities - Feed



Endpoint

GET /v1.1/activity/feed

Description

Returns the current feed of activity data for your account. Can be filtered by any combination of specific brands, campaigns etc (see full parameter list below). 
Default result set limit is 10, maximum result set is 1000. 
Results can be paged by passing offset and limit values to the limit parameter as [offset],[limit]. eg. 10,10 
Default result set limits activities to latest per member, pass in 'all_member_actions' to see full feed. 
Specify endpoint as 'feed.rss' to output as rss.
Default date range if none specified is 1 week. The maximum date range - even if a bigger range is specified - is 6 months.

IMPORTANT NOTE: The time required for a completed activity to appear in the feed is dependent on the specific level of the plan you are using. eg within an hour, within a day, etc

Parameters
required *

apiKey *  string Your API access key
brandID  integer Filter to user actions and score for a specific brand
segment  integer ID of the segment to filter by
activityID  integer ID of activity to filter by – determines scores & position. Accepts either a number (e.g. 123) or a comma-separated list (e.g. 123,678)
includeOneTime  boolean Value of 1 will show one time actions such as follows and likes (default 0)
country  string ISO 3166-1 alpha-2, comma separated list. eg US,CA,GB
region  string ISO 3166-1 alpha-2, only applicable if a single country is specified
services  string Comma separated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc
keyword  string Filters results on keyword in content field
period  string In format of ' ' - eg 2 Month, 1 Day, 3 Week
period_end  string In format of ' ' - eg 2 Month, 1 Day, 3 Week
start_date  string In format of 'YYYY-MM-DD HH:MM:SS' – start of date range for results
end_date  string In format of 'YYYY-MM-DD HH:MM:SS' – end of date range for results
order_by_recorded  boolean Override result ordering to be based on the time at which the platform records the actions, as opposed to when they were completed by the user. These values can be quite different depending on the license refresh rate
members  string Only include these members, comma separated list of native IDs – eg. 811566,803186
exclude_members  string Ignore these members, comma separated list of native IDs – eg. 811566,803186
optedin  boolean Value of 1 will only show members who have been opted into this campaign (via optin endpoint call)
all_member_actions  boolean Value of 1 shows every action by members, instead of defaulting to latest per member
anyofactivities  string The activity id or ids (comma separated), ANY OF which have been performed by the members. Append brand id in the format brandid-activityid to filter by an activity performed for a specific brand eg. 'Shared a Listen for 5 Seconds of Summer via Facebook' would be 3438697-1350
allofactivities  string The activity id or ids (comma separated), ALL OF which have been performed by each of the members. Append brand id in the format brandid-activityid to filter by an activity performed for a specific brand eg. 'Shared a Listen for 5 Seconds of Summer via Facebook' would be 3438697-1350
paid_only  boolean Filter to users who have a paid service attached eg. Spotify Premium
sort  string Must be 'asc' or 'desc'. Order by date
limit  string Limit the results, default 10, max 1000. eg 100 or 10,10 (offset,limit)

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/activity/feed?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&sort=asc"
$curl = curl_init();

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

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

Example Response

{
"totalSize": 2,
"items": [
{
"ID": "4545454545",
"Marker": "2020-04-25T23:00:00.000K",
"BrandID": "33333",
"BrandName": "Starfleet",
"Link": "https://open.spotify.com/track/0iYebKFUSfF72fUu2OW6ZT",
"Media": null,
"Category": null,
"Content": {
"TrackName": "Launchtime",
"TrackArtist": "Starfleet",
"SpotifyID": "0iYebKFUSfF72fUu2OW6ZT",
"ISRC": "ABCD51034"
},
"CompleteDate": "2355-04-25 21:00:00",
"Name": "Played a track by Starfleet on Spotify",
"ShortName": "listen",
"GeoData": null,
"MemberName": "Jean-Luc Picard",
"Value": "1",
"ActivityID": "4444",
"ActivityType": "Listened",
"ServiceType": "spotify",
"MemberID": "54321",
"ServiceUserName": "Jean-Luc Picard",
"RemoteUserURL": "https://open.spotify.com/user/123",
"ServiceUserID": "123",
"MemberEmail": "jeanluc@picard.com",
"Username": "jlp123",
"MemberAvatarURL": "http://www.someurl.com"
},
{
"ID": "6767676767",
"Marker": "2020-04-16T20:00:00.000B",
"BrandID": "2222222",
"BrandName": "USS Enterprise",
"Link": "https://open.spotify.com/track/36IjkjX9jve0xUzzdI1Bvj",
"Media": null,
"Category": null,
"Content": {
"TrackName": "Liftoff",
"TrackArtist": "USS Enterprise",
"SpotifyID": "36IjkjX9jve0xUzzdI1Bvj",
"ISRC": "ABCDZ030068"
},
"CompleteDate": "2359-04-28 21:00:00",
"Name": "Played a track by USS Enterprise on Spotify",
"ShortName": "listen",
"GeoData": null,
"MemberName": null,
"Value": "1",
"ActivityID": "4444",
"ActivityType": "Listened",
"ServiceType": "spotify",
"MemberID": "98765",
"ServiceUserName": null,
"RemoteUserURL": "https://open.spotify.com/user/1234",
"ServiceUserID": "1234",
"MemberEmail": "worf@worf.worf",
"Username": "worfworf",
"MemberAvatarURL": "http://www.someurl.com"
}
]
}