Activities - Record *

* This is an advanced endpoint. To use, please make sure your plan has advanced access.


POST /v1.1/activity/record


Manually record an activity for your data feed. Requires a pre-existing activity with ID to be created and saved in AE dashboard.

Make this call to API whenever the action has taken place in another system. For example you might insert the API call on a form submission event, or you might call a function via AJAX on a button click.

WARNING: This is a POST request and may add data to your feed when testing.

required *

apiKey *  string Your API access key
activityid *  integer The ID of the activity as it appears in your dashboard
id *  integer The ID of the user to record the activity for. Instead of id, you may provide partnerId/partnerCode combination
brandid *  integer The ID of the specific brand for this activity
partnerCode  string Code specific to partner who may be integrated with AE, eg. 'janrain'
partnerId  integer Internal user id for specified partner. PartnerId requires partnerCode
content  string Any content you want to record against the activity (eg. any message entered by the user as part of the activity)
link  string Any url associated with the activity (eg. a link to the completed activity record)
marker  string An optional unique identifier to ensure the activity can't be repeated with exactly the same information
timestamp  string An optional timestamp to record against the completed activity (if not supplied, the Appreciation Engine will default to the time we receive the api call)
async  boolean Value of 0 or 1. Default is 1. 0 = save to data views immediately. 1 = queue for next view refresh. Asynchronous calls provide better performance, but delays availability of data retrieval.

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

Example Request

curl -X POST ""
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "", 

$response = curl_exec($curl);

echo $response;
import requests

url = ""

headers = {}
payload = {}

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

var request = require('request');
var options = {
	'method': 'POST',
	'url': '',
	'headers': {}
request(options, function (error, response) {
	if (error) throw new Error(error);

Example Response

"status": "OK"