Endpoint URL: https://api.alfinsight.com/odata/Brands
Returns data ALF holds about Brands.
These can be fetched along with the Brand data using OData's $expand
option.
Spend
- Brand's historical spend data. Spend data is sourced from Nielsen.These require a separate API request based on a single Brand. If you know the BrandId of a Brand you are interested in, you can fetch related data using URL in the format:
https://api.alfinsight.com/odata/Brands({BrandId})/{Relation}
Key field(s): BrandId
To fetch details for one Brand using the key field(s), call the endpoint with URL in format:
/odata/Brands({BrandId})
Field | Data Type | Description |
---|---|---|
BrandId | Integer | Unique ID for a Brand. |
BrandName | String | The name of the Brand. |
CompanyId | Integer | Unique ID for the Company that owns the Brand. |
CompanyName | String | The name of the Company that owns the Brand. |
BrandCategoryCode | String | Unique ID for the Brand Category |
BrandCategoryName | String | The name of the Brand Category |
BrandParentCategoryCode | String | Unique ID for the Brand Parent Category |
BrandParentCategoryName | String | The name of the Brand Parent Category |
SpendRank | Integer | The rank of the Brand ordered by Total Rolling Spend |
TotalBrandSpend | Decimal | The current Total Rolling Spend for the Brand in GBP. |
TwitterUrl | String | The Brand's Twitter page if available. |
FacebookUrl | String | The Brand's Facebook page if available. |
DateUpdated | String | Date this Brand was last updated by the ALF Research team. |
Spend is expandable, so you can fetch it with Brand data in one request like this:
https://api.alfinsight.com/odata/Brands?$expand=Spend
You can also fetch Spend for one Brand in this format:
https://api.alfinsight.com/odata/Brands({BrandId})/Spend
Key field(s): BrandId, SpendType, Year, Quarter
To fetch details for one Brand Spend using the key field(s), call the endpoint with URL in format:
/odata/BrandSpend({BrandId}, {SpendType}, {Year}, {Quarter})
Field | Data Type | Description |
---|---|---|
BrandId | Integer | Unique ID for a Brand. |
SpendType | String | Period covered by Spend data - 'Rolling', 'Annual' or 'Quarterly'. |
Year | String | Year covered by Spend data. |
Quarter | String | Quarter covered by Spend data (for Rolling and Annual spend this is just the latest quarter available and is not significant). |
TotalSpend | String | Total spend (in GBP) for the time period - the sum of all spend categories. |
CinemaSpend | String | Amount spent (in GBP) in Cinema category. |
DigitalSpend | String | Amount spent (in GBP) in Digital category. |
DirectMailSpend | String | Amount spent (in GBP) in Direct Mail category. |
DoorDropSpend | String | Amount spent (in GBP) in Door Drop category. |
OutdoorSpend | String | Amount spent (in GBP) in Outdoor category. |
PressSpend | String | Amount spent (in GBP) in Press category. |
RadioSpend | String | Amount spent (in GBP) in Radio category. |
TvSpend | String | Amount spent (in GBP) in TV category. |
TvSponsorshipSpend | String | Amount spent (in GBP) in TV Sponsorship category. |
DateUpdated | String | Date this Spend data was last updated by the ALF Research team. |
You can fetch the Brand's related Companies in this format:
https://api.alfinsight.com/odata/Brands({BrandId})/Companies
Key field(s): CompanyId
To fetch details for one Company using the key field(s), call the endpoint with URL in format:
/odata/Companies({CompanyId})
Field | Data Type | Description |
---|---|---|
CompanyId | Integer | Unique ID for a Company. |
CompanyName | String | The name of the Company. |
CompanyType | String | The type of the Company. This will be either 'Advertiser' or 'Agency'. |
CategoryCode | String | Unique code for the Company Category. |
CategoryName | String | The name of the Company Category. |
Employees | Integer | Number of employees at the Company. |
ImmediateParentCompanyName | String | Immediate Parent Company, if applicable. |
UltimateParentCompanyName | String | Ultimate Parent Company, if applicable. |
TotalRollingSpend | Decimal | The current Total Rolling Spend for the Company in GBP (Advertisers only). |
RollingSpendRank | Integer | The rank of the Company ordered by Total Rolling Spend (Advertisers only). |
CategoryRollingSpendRank | Integer | The rank of the Company ordered by Total Rolling Spend within Companies of the same Category (Advertisers only). |
DeclaredBillings | Decimal | Billings (in GBP) as declared by the Company (Agencies only). |
NielsenBillings | Decimal | Billings (in GBP) as sourced by Nielsen (Agencies only). |
TwitterUrl | String | The Company's Twitter page if available. |
FacebookUrl | String | The Company's Facebook page if available. |
LinkedInUrl | String | The Company's LinkedIn page if available. |
DateUpdated | DateTime | Date this Company was last updated by the ALF Research team. |
You can fetch the Contacts working for on a Brand with a URL in this format:
https://api.alfinsight.com/odata/Brands({BrandId})/Contacts
Key field(s): JobId
To fetch details for one Contact using the key field(s), call the endpoint with URL in format:
/odata/Contacts({JobId})
Field | Data Type | Description |
---|---|---|
JobId | Integer | Unique ID for a Contact's Job role. |
PersonId | Integer | Unique ID for a Contact's personal details. A person can have more than 1 Job in the ALF database. |
Title | String | Contact's title, e.g. Mr, Mrs, Dr, Prof etc. |
FirstName | String | Contact's first name. |
LastName | String | Contact's last name. |
JobTitle | String | Contact's job title. |
CompanyType | String | Type of Company Contact works for. Will be either 'Advertiser' or 'Agency'. |
CompanyId | Integer | Unique ID for the Company the Contact works for. |
CompanyName | String | Name of Company the Contact works for. |
Telephone | String | Contact's office telephone number. If Company is registered with CTPS, this will be NULL |
String | Contact's email address. | |
Address1 | String | Line 1 of contact's office address. |
Address2 | String | Line 2 of contact's office address. |
Address3 | String | Line 3 of contact's office address. |
Address4 | String | Line 4 of contact's office address. |
Town | String | Town contact's office is based in. |
PostCode | String | Postcode of contact's office address. |
CountyName | String | County contact's office is based in. |
RegionName | String | Region contact's office is based in. |
TVRegion | String | TV Region contact's office is based in. |
CountryCode | String | ISO2 Country Code of contact's office. |
TwitterUrl | String | The Contact's Twitter page if available. |
LinkedInUrl | String | The Contact's LinkedIn page if available. |
DateUpdated | DateTime | Date this Contact was last updated by the ALF Research team. |