authority brands
API docs by Redocly

AB Analytics API Endpoints Documentation (1.0.0)

Download OpenAPI specification:Download

AuthorityBrands Analytics Support: ab_analytics@authoritybrandsllc.com

AB Analytics API endpoints provide seamless application interaction and extensive analytical Franchisee data curated by AB Analytics.

These endpoints provide a structured and efficient approach to accessing and retrieving Franchisee detail data. Emphasizing top-tier performance, robust security measures, and unparalleled flexibility, these endpoints facilitate the seamless integration of AB Analytics across a spectrum of applications.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

AB Analytics API offers two forms of authentication, both of them are required for authentication:

  1. API Key
  2. Mutual TLS: This authentication requires both the server and the client to exchange and validate certificates to establish a secure connection. follow these steps to configure your client application to use the provided client certificates (dw-dev-analytic-client.pem and dw-dev-analytic-client.key):
  • Client Certificates: Download the client certificate (dw-dev-analytic-client.pem) and its corresponding private key (dw-dev-analytic-client.key) provided by us. then place the client certificate and private key in a secure location accessible to your client application.
  • Configure Your Client Application: Update your client application to include the client certificate and private key in the TLS handshake process.

Franchisee Endpoints

The Franchisee endpoints plays a pivotal role within our API infrastructure by providing users with detailed insights into the franchisee landscape.

franchisee

The Franchisee resource provides a rich dataset that goes beyond mere contact details, including owned, serviced, and blacklisted zip codes associated with each franchisee.

Authorizations:
api_key
query Parameters
brand_abbreviation
string

Brand Abbreviation (optional)

date
string

Date in the format 'YYYY-MM-dd' (default: today's date, optional)

franchisee_name
string

Franchisee Name (optional)

page
string

Page number (default: 1, optional)

per_page
string

Items per page (default: 20, max allowed: 100, optional)

Responses

Request samples 

import requests
url = 'https://ab-analytics-api.dev.dw.theauthoritybrands.com/dev/franchisee'
cert = ('/path/to/dw-dev-analytic-client.pem', '/path/to/dw-dev-analytic-client.key')
api_key = 'x-api-key provided by us'
headers = {
'x-api-key': api_key
}
response = requests.get(url, headers=headers, cert=cert)
print(response.text)

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "data": [
    ]
}

Brand Endpoints

The Brand endpoints plays a pivotal role within our API infrastructure by providing users with detailed insights into the brand landscape.

brand

The Brand resource offering the capability to retrieve a comprehensive list of all available brands. The data retrieved from the Brands endpoint is very specific, including a unique identifier for each brand, a concise short abbreviation, and the brand's full name.

Authorizations:
api_key
query Parameters
per_page
string

Items per page (default: 20, max allowed: 100, optional)

page
string

Page number (default: 1, optional)

Responses

Request samples 

import requests
url = 'https://ab-analytics-api.dev.dw.theauthoritybrands.com/dev/brand'
cert = ('/path/to/dw-dev-analytic-client.pem', '/path/to/dw-dev-analytic-client.key')
api_key = 'x-api-key provided by us'
headers = {
'x-api-key': api_key
}
response = requests.get(url, headers=headers, cert=cert)
print(response.text)

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "data": [
    ]
}