Metrics Screen
To access the area of the app where you can manage and create metrics you will first need to click the Data option on the side nav bar.
NOTE: Throughout this document we will use the term Metric and Metric Definition. These are how we define those two terms:
Metric - A metric is a line of data coming in from an org. This would be “a margarita was sold on 4/2/25”, think of it as the line items you see in the Campaigns screen
Metric Definition - A metric definition is what we will mostly be referring to in this document. A metric definition is the structure of what the SocialCrowd app is tracking. An example is “an API metric that tracks items sold under the menu category “appetizers”.
The table below will outline all of the features on this main table screen:
Feature | Detail |
Name | The name of the Metric Definition. This is set by the user. |
Locations | This will show up for API based metric definitions and will show the locations we’re using with the API. |
Type | This will let you know if the metric is Manual, Report-Based, or API Based. For API-Based metric definitionss it will also indicate if the metric definition is paused or active, with a button to activate or pause the metric definition accordingly. |
Used In | This column will indicate if the metric definition is being used in any campaigns and hovering over the pillbox will show all of the campaigns that are using this metric definition. |
Description | This will display the description for the metric definition. This description is set by the user. |
ID | This is a unique ID for every metric definition which is an attribute we use on the backend. This mostly will be useful to the end user for any troubleshooting that may arise. |
Action | There are two possible buttons here:
|
Creating New Metric Definitions
To start, click the Add New Metric button on the Metrics table.
The first question the flow will ask is what type of metric definition you want to create. We will detail creating metric definitions in left to right order, starting with Manual Metric Definitions.
Manual and Report Metric Definitions
Creating a manual or a report-based metric definition is the fastest, simplest variation of this flow. As a reminder, Manual metric definitions are not powered by any automation or reports, meaning that any time the criteria of a metric definition is met, a user has to manually enter that into the SocialCrowd app from the associated campaigns. For details on how our report-based metric entry works, please refer to our Metric Uploader help article.
To create a Manual or Report Metric Definition, simply set a name and description. In doing so, after clicking Create Metric, the new metric definition is created and the flow is completed.
NOTE:
Name and Description will be needed for ALL THREE types of metric definitions and is always the next step in the flow whether the user selects Manual, Report, or API in the above step.
API-Based Metric Definitions
The most feature-rich, deep, and valuable part of the Metric Definition creation feature lies within the API-based Metric Definitions. This allows SocialCrowd to create metric definitions that link directly to customers' menus (and in the future other platforms like their CRMs, Marketing Automation platforms, HR platforms, etc).
The creation of API-based metric definitions comes in 5 steps, detailed below:
Step | Detail |
Basic Info | Where the user enters name and description |
Connection | Where the user determines which integration option (ie, Shift4, Clover) and which integration location(s) to use. |
Query Type | This is where we determine what we’re asking for from the integration at the higher level. An example would include: ticket line items, expressed as quantity sold. |
Filters | This is where the user determines which actual metrics are tracked against the queries set in the previous step. An example is: any sale of an item in the “Drink Specials” category. |
Confirm | This is the final confirmation screen. Users can do a single-day data test and can assign the metric to a campaign from this screen. |
Since we’ve already detailed Step 1, we will skip right to Step 2.
Step 2: Connection
In this step, you will first select an Integration option in the INTEGRATION field. A quick disctinction:
Integration Option - this refers to the integration partner such as Shift4, Toast, Clover, Workday, Salesforce.
Integration Location - this refers to specific locations we’re connected to. For POS integrations this is more common, as separate stores usually have separate integration IDs.
Once your Integration option is selected, an additional question will display asking to select any locations. This is a multi-select checkbox.
Step 3: Query Type
The next step is to define what the metric definition is going to bring back to the SocialCrowd app. There are two selections the user must make: Type and Value. The Values available to the user is dependent upon which Type has been selected. Below are screenshots showing the various options and then below are table detailing each selection.
Below are three tables. The first details the Metric Type options, the second details the Value options for Ticket Line Items, and the third details the Value options for Tickets.
Type | Detail |
Ticket Line Items | This will tell SocialCrowd to bring back metrics that look at line items from a ticket. Think of the individual line items you see on your receipt when you go to a restaurant. |
Tickets | This will tell SocialCrowd to bring back metrics that look at entire tickets. Think of the whole receipt you get when you go to a restuarant. |
Tickets - Option | Detail |
Total Time | The time (in minutes) from ticket opening to ticket closing. |
Grand Total | The final amount paid for the ticket. |
Total Items | The total price of the items on the ticket. |
Total Discounts | The sum of all discounts applied to the ticket. |
Total Surcharges | The sum of all surcharges on the ticket. |
Guest Count | The total number of guests listed on the ticket. |
Count | A constant value of 1 for each ticket |
Ticket Line Items - Option | Detail |
Quantity | The number of a certain item sold on a ticket. |
Item Amount | The amount a line item on a ticket was sold for. |
Discount Amount | The amount discounted (positive number) or refunded (negative number) of a single item sold on a ticket. |
Modifier Amount | The amount a modifier was sold for. |
Price | The full cost of the item on the ticket, excluding tax. |
Unit Price | The full cost of the item on the ticket, excluding modifiers and discounts. |
Once you’ve selected a Type and a Value you can move on to Step 4 which is to select the actual filters of the metric definition.
Step 4: Filters
The next step is to actually create the filters of the metric definition. This is telling SocialCrowd what to actually look for. So in our above step let’s say we selected Ticket Line Items and Quantity. That tells SocialCrowd we will post metrics based on line items on a ticket and display how MANY sales came on that line items.
The filters we are about to select will then tell SocialCrowd what actual line items we care about. Below are some screenshots and tables to show various options. At the end, we will continue the above example.
First we must select a field type. Below is a screenshot with the various options and a table detailing each option.
Field Option | Detail | Type |
Item Name | The name of the item as it appears on the menu. | String |
Item POS Ref | The POS reference number for an item on the menu. | String |
Modifier Names | The name of the modifier as it appears on the menu. | String |
Item Type | The type of sale of the item (sale, refund, void, or overring). | String |
Category Name | The name of the category as it appears on the menu. | String |
Modifier Amount | The amount a modifier was sold for. | Numeric |
Price | The full cost of the item on the ticket, excluding tax. | Numeric |
Unit Price | The full cost of the item on the ticket, excluding modifiers and discounts. | Numeric |
Discount Amount | The amount discounted (positive number) or refunded (negative number) of a single item sold on a ticket. | Numeric |
Item Amount | The amount a line item on a ticket was sold for. | Numeric |
Quantity | The number of a certain item sold on a ticket. | Numeric |
Revenue Class Name | The name of the revenue class as it appears on the menu. | String |
Revenue Class POS Ref | The POS reference number of the revenue class. | String |
NOTE:
There is a tooltip next to this field that details each of these options directly within the app’s interface. However, I am writing this out here as well to detail which ones are numeric vs string-based.
Let’s pick Item Name. Next is our operator. Since this item name is a STRING, rather than NUMERIC, our operator options are: Matches, Not Matches, Includes, and Not Includes.
Had we picked a NUMERIC field type, like Price, our operator options would’ve been: Less Than, Less Than or Equal To, Greater Than, or Greater Than or Equal To.
NOTE:
All monetary values can be expressed as dollars and cents. So a slice of cheesecake priced at $6.78 would be entered as “6.78”
Field Type | Options |
String |
|
Numeric |
|
Once an operator has been selected, we can now actually select values. The options here are entirely dependent upon the customer’s menu and what we’re getting from the API. Below is a screenshot showing how to select options from their menu, OR, how to create new strings entirely.
Clicking into the value field will bring up a large modal that will show you everything we’re getting back from the customer’s menu as well as some metadata for each item. You can select any number of options here. Any options selected beyond the first will be treated as an OR relationship.
Additionally, if you want to let’s say look for any item that includes the string of words “Flippy” in it, you can type “Flippy” and if there are no options for it you can create a new string that just looks for those letters as a filter.
Additionally you may see a checkbox that says “case-insensitive matching” and when checked it means that the app allows the user to match on strings regardless of upper or lower case.
You must click SAVE in the top right of this screen to continue. Afterwards, you can also select the Add Another Filter button to add an additional filter. Anything added here will be treated as an AND relationship.
NOTE:
As a recap:
Any items WITHIN the value field (Blackened Chicken and Baked Potato in the below screenshot) are treated with an OR relationship.
Any items after clicking Add Another Filter, that is, any lines separated by an “and” are treated with an AND relationship.
With the below example, we are looking for any Blackened Chicken OR Baked Potatoes AND they must have been sales, rather than voids or refunds.
Once you are done you can click to complete creating the filters where you will be brought to the confirmation screen.
So now that we’ve finished the filters, let’s think about the example used earlier. We selected:
Step 3:
Ticket Line Items
Quantity
Step 4:
Item Name MATCHES Blackened Chicken or Baked Potato
AND
Item Type MATCHES Sale
This means SocialCrowd will look for line items on tickets coming from this org’s Ruth - Hailey location. It will ONLY post any sales for Blackened Chicken or Baked Potatoes, ignoring any voided or refunded items. It will post these metrics and show the quantity of items sold on given line items.
Step 5: Confirm
On the confirmation screen there are three main things you can do:
Review the metric details, reviewing the name, description, integration, values, locations, and filters you selected.
Test data, selecting a single date to review the data we get back to verify the metric would work as you’d expect it to.
Assign this new metric to a campaign.
To test your metric, you must first select a date. This date is a single select so as to limit the potential amount of data coming it and to keep the experience quick and performant. Once you’ve selected a date, if we are getting back data from the API for the filters selected, they will appear in a table.
NOTE:
The data that generates here is test data ONLY. This data does NOT post to SocialCrowd as metrics for later use in a campaign. It is purely intended to be used as a way to double check whether the metric definition you’ve just set up works as expected.
Lastly, we will assign this new metric definition we’ve created to a campaign right from this screen. By clicking the Select Campaigns option, you will see a dropdown with all campaigns in that organization. Once one is selected, then close this dropdown and you will have to click Attach to Selected Campaigns.
And once you’ve clicked Finish you’re done! You have your new Metric Definition up and running!
Managing Metric Definitions
Back to the main Metrics screen, there are a few more things to review. You can manage metrics in a few different wants:
Edit Filters
Delete Metric Definition
Pause/Unpause API-Based Metrics
Permissions
First, let’s establish WHEN we can do these actions.
NOTE:
You can ONLY edit, delete, or pause/unpause metrics when they are NOT being used by any campaigns, or, are ONLY used by campaigns currently in TEST mode. Lastly, you can only edit metric definitions you created.
Deleting Metric Definitions
You can click the trash can icon to delete a metric definition. Deleting a metric definition does NOT delete any metrics that have historically come in for that metric definition, but it will remove any associate they had historically to campaigns, meaning those metrics will now be “orphaned”
Editing Metric Definitions
Clicking the Filter icon will bring up a modal to edit the filters of a metric definition where you can re-define the filters used for that metric definition.
Pausing/Unpausing Metric Definitions
For any API-Based Metric Definitions, you can pause and unpause the metric definition. What does pausing mean exactly? It simply means that the app will no longer look for that metric when it runs processing on campaigns.
To pause/unpause a metric definition there will be a play or pause button, depending on the state the metric definition is in. Clicking this will flip it to pause/unpause accordingly.
