Skip to main content

API ENDPOINT - General Analytics

Summary

This endpoint retrieves summary analytics data for a specified date range. It allows users to obtain insights related to various metrics such as scans, registrations, rebates, and revenues on a per Experience basis. The response is similar to what you’d get from the CSV export function in the General Analytics dashboard in the Brij platform.

  • Method: GET

  • URL: https://{{Base_URL}}/analytics/summary

    • Ask your account manager for the full URL

  • Auth: API-KEY: <your key> (header)

Benefits

  • Run a nightly call to populate your BI Tool database with yesterday's performance metrics, and power your own BI queries or dashboards

  • Automate comparisons of performance across different periods of time and/or different experiences

Request Parameters

The request is made via an HTTP GET method and requires the following query parameters:

  • startDate (string, required): The start date for the analytics data in ISO 8601 format (e.g., 2022-10-26T13:55:14.564Z).
  • endDate (string, required): The end date for the analytics data in ISO 8601 format (e.g., 2025-09-17T17:03:14.482Z).
  • page (integer, optional): The page number for pagination of results. Default is 1.
  • limit (integer, optional) The limit is for number of records for each request. Default is 365 and max is 1000.

Response Structure

On a successful request, the API responds with a JSON object containing the following structure:

  • data (array): An array of objects, each representing a summary of analytics data. Each object includes:
    • Period Start Date (string): The start date of the reporting period. All data is counted from events happening within this period.
    • Period End Date (string): The end date of the reporting period.
    • Experience ID (string): Unique identifier for the experience.
    • Brij ID (string): Identifier for the Experience that is also used in the URL. Sometimes referred to as the “slug”.
    • Experience Name (string): Name of the Experience.
    • Experience Type (string): Type of experience: Web App, Digital Hub, Dynamic Link, or Rebate.
    • Variant Name (string): Name of the variant, if this is a variant experience. Will be blank for parent (product) experiences.
    • Brand Name (string): Name of the brand account. This is useful if you are exporting data as an organization with multiple brand accounts within the organization account.
    • Parent Org (string): Name of the parent organization account.
    • Scans/ Clicks (integer): Total scans or clicks (page loads) recorded by customers.
    • Registration Eligible Scans/Clicks (integer): Scans or clicks (page loads) for experiences where registration is required. If you are not asking for emails in an experience then the scan is not eligible to be counted in this metric.
    • Registration Initiations (integer): Sometimes referred to as sign-ups. Number of registrations initiated, where an email was submitted. This creates a profile for the customer in Brij. A customer can have multiple registrations, or initiations, but only one profile.
    • Registration Submissions (integer): Number of registrations completed. If an experience asks for more than email in a registration flow, then a registration could be initiated but not submitted, meaning they didn’t finish answering the questions asked of them. Sometimes only email is collected and thus the submission happens at the same time as the initiation and the two are synonymous for that Experience.
    • Registration Approvals (integer): Number of registrations approved. Approval can be automatic, making this synonymous with Registration Submissions. There is an option to require approval in which case an admin user must manually approve the registration submission from within Brij, triggering this event to be counted here.
    • Registration Denials (integer): Number of registrations denied. If approvals are enabled for an experience, there is also the option for admins to deny them from within the Brij platform.
    • Rebate Initiations (integer): Number of rebates initiated. An initiation happens once the phone number is submitted, either in a Rebate Experience or by texting the rebate campaign phone number directly.
    • Rebate Submissions (integer): Number of rebates submitted. This happens when a receipt is uploaded in the experience or texted to the rebate campaign phone number.
    • Rebate Approvals (integer): Number of rebates approved. This means the receipt was valid and the customer is eligible to receive payout. Rebates are approved from within the Brij platform with AI assistance by a Brij admin.
    • Rebate Payouts (integer): Number of rebates paid out.
    • Rebate Payout Value ($) (integer): Total value of rebate payouts in dollars within the requested time period.
    • Registration Rate (eligible scans) (integer): Rate of conversion from Scan to Initiation, using only “eligible scans” as defined above.
    • Form/Survey Submissions (integer): Number of forms submitted, whether as part of the registration or as a separate module after registration submission.
    • Engagements (integer): Total engagements recorded. Engagements are interactions with different pages or modules in the experience. This tells you how much they are engaging with content in the experiences.
    • Website Visits (integer): Total website visits from Brij to your external site.
    • Direct Revenue (integer): Total direct revenue generated in Shopify from within Brij’s Shopping Module, which takes customers directly to checkout in Shopify with a deep link.
    • Indirect Revenue (integer): Total indirect revenue generated in Shopify by a customer that had an email collected in Brij before the order was placed in Shopify (or other integrated ecommerce website like Salesforce Commerce Cloud)
    • Total Revenue (integer): Total revenue generated in your ecommerce store by customers with emails collected in this experience. Order date is used, within the period filters, not the date of that customers registration.
    • Customer Profiles (BOP) (integer): Number of customer profiles at the beginning of the period.
    • Customer Profiles (EOP) (integer): Number of customer profiles at the end of the period.
    • Customer Profiles Created (integer): Number of new customer profiles created during period.
    • Module Types (string): Types of modules used in the experience.
  • limit (integer): The limit of records returned.
  • pageInfo (string): Information related to pagination.
  • returnedCount (integer): The count of records returned in the response.

Status Codes

  • 200 OK: The request was successful, and the response contains the requested data.

Request cURL

curl --location '<{{Base_URL}}/analytics/summary?endDate=2025-09-17T17%3A03%3A14.482Z&startDate=2022-10-26T13%3A55%3A14.564Z&page=1&limit=1000>' \\ --header 'API-KEY: {{apiKey}}'

Example Response

{
   "data": [
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "k8pL2jWq9rBvF7hZ",
           "Brij ID": "KYED",
           "Experience Name": "Web App",
           "Experience Type": "Web App",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 2,
           "Registration Eligible Scans/Clicks": 2,
           "Registration Initiations": 1,
           "Registration Submissions": 1,
           "Registration Approvals": 1,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0.5,
           "Form/Survey Submissions": 1,
           "Engagements": 8,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 1,
           "Customer Profiles (EOP)": 2,
           "Customer Profiles Created": 1,
           "Module Types": "\"Forms Module\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "3mYx6zT1hR5cVgQ9",
           "Brij ID": "J48D",
           "Experience Name": "Digital Hub",
           "Experience Type": "Digital Hub",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 1,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 4,
           "Website Visits": 3,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "7aZf3eP5kQ9dM2jN",
           "Brij ID": "89E4",
           "Experience Name": "Dynamic Link",
           "Experience Type": "Dynamic Link",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 0,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 0,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "B4hW8sR1gV6cM3qP",
           "Brij ID": "1654",
           "Experience Name": "Geo Dynamic Link Experience",
           "Experience Type": "Dynamic Link",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 0,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 0,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "F2jN7aT9dG4pL1rV",
           "Brij ID": "PPR8",
           "Experience Name": "WebApp TEST",
           "Experience Type": "Web App",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 9,
           "Registration Eligible Scans/Clicks": 9,
           "Registration Initiations": 5,
           "Registration Submissions": 5,
           "Registration Approvals": 5,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0.5555555555555556,
           "Form/Survey Submissions": 0,
           "Engagements": 61,
           "Website Visits": 8,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 3,
           "Customer Profiles Created": 3,
           "Module Types": "\"Warranty Module, Discount Module, Forms Module, Reviews Module, Custom Module, Iframe Module, Link Module, Video Module, Document Module, Sweepstakes Module, AB899 Module\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "T5sR2jV9hZ3mC1gP",
           "Brij ID": "DH56",
           "Experience Name": "SLYR Pro Wireless PlayStation",
           "Experience Type": "Dynamic Link",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 0,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 0,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"Custom Module, Link Module\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "D1pM6vF8gQ4jN7aK",
           "Brij ID": "SH6K",
           "Experience Name": "demo",
           "Experience Type": "Web App",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 0,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 0,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "L2qW9rB4fG7hZ3mN",
           "Brij ID": "KG85",
           "Experience Name": "WebApp TEST",
           "Experience Type": "Web App",
           "Variant Name": "Variant Experience",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 0,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 0,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"Warranty Module, Discount Module, Forms Module, Reviews Module, Custom Module, Iframe Module, Link Module, Video Module, Document Module, Sweepstakes Module, AB899 Module\""
       },
       {
           "Period Start Date": "2025-10-01T13:55:14.564Z",
           "Period End Date": "2025-12-31T17:03:14.482Z",
           "Experience ID": "Q8hZ3mP5vR7sK1cT",
           "Brij ID": "YUIO",
           "Experience Name": "REBATE Test",
           "Experience Type": "Rebate",
           "Variant Name": "",
           "Brand Name": "Demo",
           "Parent Org": "",
           "Scans/ Clicks": 0,
           "Registration Eligible Scans/Clicks": 0,
           "Registration Initiations": 0,
           "Registration Submissions": 0,
           "Registration Approvals": 0,
           "Registration Denials": 0,
           "Rebate Initiations": 0,
           "Rebate Submissions": 0,
           "Rebate Approvals": 0,
           "Rebate Payouts": 0,
           "Rebate Payout Value ($)": 0,
           "Registration Rate (eligible scans)": 0,
           "Form/Survey Submissions": 0,
           "Engagements": 0,
           "Website Visits": 0,
           "Direct Revenue": 0,
           "Indirect Revenue": 0,
           "Total Revenue": 0,
           "Customer Profiles (BOP)": 0,
           "Customer Profiles (EOP)": 0,
           "Customer Profiles Created": 0,
           "Module Types": "\"\""
       }
   ],
   "limit": 1000,
   "pageInfo": "Page 1 of 1",
   "returnedCount": 9
}
Updated

Was this article helpful?

0 out of 0 found this helpful

Related articles