Skip to content
Steer Analytics API

Business360 Data Model

Hierarchy Query

Section titled “Hierarchy Query”

Organizational structure showing brand, tenant, and shop relationships.

Field Specifications

Section titled “Field Specifications”
Field NameData TypeDescription
BRAND_IDString (UUID)Unique brand identifier
BRAND_NAMEStringBrand display name
TENANT_IDString (UUID)Unique tenant identifier
TENANT_NAMEStringTenant organization name
SHOP_IDString (UUID)Unique shop location identifier
SHOP_NAMEStringShop location display name

Sample Record

Section titled “Sample Record”
{
  "data": [
    [
      "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "Premier Auto Group",
      "f2e3d4c5-b6a7-8901-2345-6789abcdef01",
      "Premier Auto - Corporate",
      "c3d4e5f6-a7b8-9012-3456-789abcdef012",
      "Premier Auto - Downtown"
    ]
  ],
  "metadata": {
    "rowType": [
      {"name": "BRAND_ID", "type": "text"},
      {"name": "BRAND_NAME", "type": "text"},
      {"name": "TENANT_ID", "type": "text"},
      {"name": "TENANT_NAME", "type": "text"},
      {"name": "SHOP_ID", "type": "text"},
      {"name": "SHOP_NAME", "type": "text"}
    ]
  }
}

Insights Queries

Section titled “Insights Queries”

Monthly aggregated performance metrics and KPIs at three hierarchical levels: Brand, Tenant, and Shop. All three queries share the same 42 performance metrics but differ in their aggregation granularity.

Aggregation Levels

Section titled “Aggregation Levels”

Query Type: business360-insights-brand

Aggregated metrics across all tenants and shops within a brand, providing executive-level insights.

Identification Fields by Level

Section titled “Identification Fields by Level”
Field NameBrand LevelTenant LevelShop LevelData TypeDescription
BRAND_ID✅✅✅String (UUID)Unique brand identifier
TENANT_ID❌✅✅String (UUID)Unique tenant identifier
SHOP_ID❌❌✅String (UUID)Unique shop location identifier
AGGREGATED_PERIOD✅✅✅String (YYYY-MM)Monthly aggregation period

Shared Performance Metrics

Section titled “Shared Performance Metrics”

All three aggregation levels include the following 42 performance metrics:

Text Messaging Metrics

Section titled “Text Messaging Metrics”
Field NameData TypeDescription
TEXTS_SENTIntegerTotal texts sent
TEXTS_SENT_FOLLOW_UPIntegerFollow-up texts sent
TEXTS_SENT_OUTREACHIntegerOutreach texts sent
TEXTS_SENT_MAINTENANCE_REMINDERSIntegerMaintenance reminder texts
TEXTS_SENT_DEFERRED_SERVICESIntegerDeferred services texts

Email Messaging Metrics

Section titled “Email Messaging Metrics”
Field NameData TypeDescription
EMAILS_SENTIntegerTotal emails sent
EMAILS_SENT_FOLLOW_UPIntegerFollow-up emails sent
EMAILS_SENT_OUTREACHIntegerOutreach emails sent
EMAILS_SENT_MAINTENANCE_REMINDERSIntegerMaintenance reminder emails
EMAILS_SENT_DEFERRED_SERVICESIntegerDeferred services emails

Email Engagement Rates

Section titled “Email Engagement Rates”
Field NameData TypeDescription
EMAILS_UNIQUE_OPEN_RATEDecimal (%)Overall unique open rate
EMAILS_UNIQUE_OPEN_RATE_FOLLOW_UPDecimal (%)Follow-up unique open rate
EMAILS_UNIQUE_OPEN_RATE_OUTREACHDecimal (%)Outreach unique open rate
EMAILS_UNIQUE_OPEN_RATE_MAINTENANCE_REMINDERSDecimal (%)Maintenance reminder open rate
EMAILS_UNIQUE_OPEN_RATE_DEFERRED_SERVICESDecimal (%)Deferred services open rate
EMAIL_UNSUBSCRIBE_RATEDecimal (%)Overall unsubscribe rate
EMAILS_UNSUBSCRIBE_RATE_FOLLOW_UPDecimal (%)Follow-up unsubscribe rate
EMAILS_UNSUBSCRIBE_RATE_OUTREACHDecimal (%)Outreach unsubscribe rate
EMAILS_UNSUBSCRIBE_RATE_MAINTENANCE_REMINDERSDecimal (%)Maintenance reminder unsubscribe rate
EMAILS_UNSUBSCRIBE_RATE_DEFERRED_SERVICESDecimal (%)Deferred services unsubscribe rate

Email Click Metrics

Section titled “Email Click Metrics”
Field NameData TypeDescription
EMAILS_CLICKS_UNIQUEIntegerTotal unique clicks
EMAILS_CLICKS_FOLLOW_UPIntegerFollow-up clicks
EMAILS_CLICKS_OUTREACHIntegerOutreach clicks
EMAILS_CLICKS_MAINTENANCE_REMINDERSIntegerMaintenance reminder clicks
EMAILS_CLICKS_DEFERRED_SERVICESIntegerDeferred services clicks

Appointment Metrics

Section titled “Appointment Metrics”
Field NameData TypeDescription
APPOINTMENTSIntegerTotal appointments
APPOINTMENTS_STEERIntegerSteer-sourced appointments
APPOINTMENTS_MANUALIntegerManually created appointments
APPOINTMENTS_SMSIntegerSMS-sourced appointments
APPOINTMENTS_SCHEDULED_GOOGLEIntegerGoogle-scheduled appointments
APPOINTMENTS_AUTO_OPSIntegerAutoOps appointments

Financial Metrics

Section titled “Financial Metrics”
Field NameData TypeDescription
INVOICESIntegerTotal invoices
INVOICES_SALES_TOTALDecimalTotal sales revenue
INVOICES_SALES_AVERAGEDecimalAverage invoice amount

Review Metrics

Section titled “Review Metrics”
Field NameData TypeDescription
REVIEWSIntegerTotal reviews
REVIEWS_RATING_AVERAGEDecimalAverage rating score
REVIEWS_REPLIES_COUNTIntegerNumber of review replies
REVIEWS_GOOGLEIntegerGoogle reviews
REVIEWS_FACEBOOKIntegerFacebook reviews
REVIEWS_MECHANIC_ADVISORIntegerMechanic Advisor reviews
REVIEWS_MANUALIntegerManually entered reviews
REVIEWS_YELPIntegerYelp reviews

Sample Records by Aggregation Level

Section titled “Sample Records by Aggregation Level”

Brand-level aggregation across all tenants and shops:

{
  "data": [
    [
      "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "2025-10",
      "225745",
      "57080",
      "132893",
      "18376",
      "17396",
      "124244",
      "30108",
      "68624",
      "14176",
      "11336",
      "40.340100",
      "44.412600",
      "36.985100",
      "41.719400",
      "48.533100",
      "0.835700",
      "0.544400",
      "0.926700",
      "0.853800",
      "1.014100",
      "2233",
      "1450",
      "341",
      "132",
      "2233",
      "0",
      "0",
      "0",
      "0",
      "0",
      "0",
      "9277468.44",
      "667.44",
      "13900",
      "173",
      "4.69",
      "478",
      "0",
      "0",
      "0",
      "10",
      "488"
    ]
  ],
  "metadata": {
    "rowType": [
      {"name": "BRAND_ID", "type": "text"},
      {"name": "AGGREGATED_PERIOD", "type": "text"},
      {"name": "TEXTS_SENT", "type": "fixed"},
      {"name": "TEXTS_SENT_FOLLOW_UP", "type": "fixed"},
      {"name": "TEXTS_SENT_OUTREACH", "type": "fixed"},
      {"name": "TEXTS_SENT_MAINTENANCE_REMINDERS", "type": "fixed"},
      {"name": "TEXTS_SENT_DEFERRED_SERVICES", "type": "fixed"},
      {"name": "EMAILS_SENT", "type": "fixed"},
      {"name": "EMAILS_SENT_FOLLOW_UP", "type": "fixed"},
      {"name": "EMAILS_SENT_OUTREACH", "type": "fixed"},
      {"name": "EMAILS_SENT_MAINTENANCE_REMINDERS", "type": "fixed"},
      {"name": "EMAILS_SENT_DEFERRED_SERVICES", "type": "fixed"},
      {"name": "EMAILS_UNIQUE_OPEN_RATE", "type": "fixed"},
      {"name": "EMAILS_UNIQUE_OPEN_RATE_FOLLOW_UP", "type": "fixed"},
      {"name": "EMAILS_UNIQUE_OPEN_RATE_OUTREACH", "type": "fixed"},
      {"name": "EMAILS_UNIQUE_OPEN_RATE_MAINTENANCE_REMINDERS", "type": "fixed"},
      {"name": "EMAILS_UNIQUE_OPEN_RATE_DEFERRED_SERVICES", "type": "fixed"},
      {"name": "EMAIL_UNSUBSCRIBE_RATE", "type": "fixed"},
      {"name": "EMAILS_UNSUBSCRIBE_RATE_FOLLOW_UP", "type": "fixed"},
      {"name": "EMAILS_UNSUBSCRIBE_RATE_OUTREACH", "type": "fixed"},
      {"name": "EMAILS_UNSUBSCRIBE_RATE_MAINTENANCE_REMINDERS", "type": "fixed"},
      {"name": "EMAILS_UNSUBSCRIBE_RATE_DEFERRED_SERVICES", "type": "fixed"},
      {"name": "EMAILS_CLICKS_UNIQUE", "type": "fixed"},
      {"name": "EMAILS_CLICKS_FOLLOW_UP", "type": "fixed"},
      {"name": "EMAILS_CLICKS_OUTREACH", "type": "fixed"},
      {"name": "EMAILS_CLICKS_MAINTENANCE_REMINDERS", "type": "fixed"},
      {"name": "EMAILS_CLICKS_DEFERRED_SERVICES", "type": "fixed"},
      {"name": "APPOINTMENTS_STEER", "type": "fixed"},
      {"name": "APPOINTMENTS_MANUAL", "type": "fixed"},
      {"name": "APPOINTMENTS_SMS", "type": "fixed"},
      {"name": "APPOINTMENTS_SCHEDULED_GOOGLE", "type": "fixed"},
      {"name": "APPOINTMENTS_AUTO_OPS", "type": "fixed"},
      {"name": "APPOINTMENTS", "type": "fixed"},
      {"name": "INVOICES_SALES_TOTAL", "type": "real"},
      {"name": "INVOICES_SALES_AVERAGE", "type": "real"},
      {"name": "INVOICES", "type": "fixed"},
      {"name": "REVIEWS_REPLIES_COUNT", "type": "fixed"},
      {"name": "REVIEWS_RATING_AVERAGE", "type": "fixed"},
      {"name": "REVIEWS_GOOGLE", "type": "fixed"},
      {"name": "REVIEWS_FACEBOOK", "type": "fixed"},
      {"name": "REVIEWS_MECHANIC_ADVISOR", "type": "fixed"},
      {"name": "REVIEWS_MANUAL", "type": "fixed"},
      {"name": "REVIEWS_YELP", "type": "fixed"},
      {"name": "REVIEWS", "type": "fixed"}
    ]
  }
}