Appearance
Creating and managing campaigns
INFO
If you missed it, see what we mean by campaigns here.
If you are a developer and want to see how to do it programmatically, check our dedicated page.
The campaigns' page is available under the Receipt Analyzer > Promotions menu item.
Create a new campaign
- First, click on the
New campaignbutton - Fill in the form with the campaign name (used to retrieve it later) and the language in which the receipts will be analyzed.
WARNING
Selecting the right language is very important as it will impact the performance of analysis.
- Click on the
Create button - The newly-created campaign will be displayed in the list
Managing campaigns
From the campaign list, you can click on any campaign to manage it.
From the details page, you can:
- rename it
- set the Outgoing Url (what is an Outgoing Url ?)
- set the language in which its receipts will be analyzed
- delete it
- export its data as csv
- upload a new receipt associated to it
- manage its validation rules (here is a guide on how to master campaign rules)
The list of receipts associated to it will be displayed, and you can click on any receipt to visualize its details.
Campaign validation rules
You can access the rules management page by clicking on the Edit validation rules link on the campaign details page top bar.
- First, enter a name for this set of rules, this is especially useful for retrieving a given set of rules when our system sends you the full analysis in JSON format
- Edit rules as you wish, adding for example a period for this promotion
- By clicking on any of the
Edit Listin theProduct rulessection, you can either add product keywords to detect in the receipt or product keywords to avoid.
TIP
When you add a product name to detect, it fits the use-case "I want all receipts in the campaign to contain one of the products in the list to validate my rules".
Add as many products as you want. You can also upload a CSV (following our downloadable template) to make it easier to list products.
- Now scroll down to the
Summarysection, you should see a sentence explaining which rules you have entered during the previous steps. - On the right we generate for you the rules as JSON that is compatible with our API. This is especially useful when you want to test a set of complex rules on the UI to reuse them via a more automated process via your back-end / API. Or just to learn how the rules API works.
- You can test product rules directly from the interface to check if your product keywords will match your created rules.
- Now that your rule set is working, you need to save it. Click on the
Save rulesbutton at the bottom right side of the window.
WARNING
You will not be charge for updating your validation rules because data are not all reprocessed.
Now that you set up your campaign rules, any receipt associated to this promotion campaign will be validated against these rules. The receipts can fully validate the rules, validate only some of them, or none. This validation status will be displayed on the interface.
Kweeri