Brands - Show

Endpoint

GET /v1.1/brand/[BrandID]

Description

Returns all available information for the specified user.
Context of information displayed, such as score and actions is determined by the additional parameters passed. eg. campaign.

User can be identified using native 'id', 'email' or associated partnerId/partnerCode combination

Parameters
required *

apiKey *	`string`	Your API access key
[brandID] *	`integer`	The ID of the brand to be queried

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?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"

$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/brand/1234?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/brand/1234?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/brand/1234?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{

  "Name": "Starfleet",

  "Slug": "starfleet",

  "Type": "TV",

  "OfficialWebsiteURL": "https://memory-alpha.fandom.com/wiki/Starfleet",

  "FacebookURL": "https://www.facebook.com/StarTrekFleetCommand",

  "FacebookID": "153926535321487",

  "TwitterURL": "https://twitter.com/hashtag/starfleet",

  "TwitterScreenName": "starfleet",

  "TwitterID": "1011038466996662273",

  "SpotifyURL": "https://open.spotify.com/artist/4vOkauYTuQV2cDee4YsERr",

  "SpotifyID": "4vOkauYTuQV2cDee4YsERr",

  "WikipediaURL": "https://en.wikipedia.org/wiki/Starfleet",

  "ID": 1701,

  "ImageURL": "http://someurl.com/brand/starfleet/image"

}