Configuring Appmax as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Appmax option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
Appmax authenticates with an API key issued for your account. In the Appmax admin panel, go to Integrations and open the API section to generate or copy the key. The following configurations are available:- API key: the key copied from the Appmax panel, under Integrations. Required.
- Orders per page: how many orders are requested per page during the extraction. The default of 100 suits most accounts — lower it only if Appmax rejects the value.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis.Tip: The stream can be found more easily by typing its name.
The buyer’s data — name, email, phone and document number — arrives inside each order, in the customer field, as a JSON object. Appmax has no endpoint that lists customers on their own, so there is no separate Customers stream.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: the Appmax orders endpoint accepts no date filter, so Orders is replicated as full table — every run reads the complete order history and refreshes the table. Read more about Sync Types here.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).Because every run reads the full order history, an account with a large volume of orders takes longer as it grows. Daily extractions are usually enough for sales analysis.
- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Below you’ll find all available data streams from Appmax and their corresponding fields.Orders
Orders
Every order registered in the Appmax account, with its amounts, payment method, current status and the buyer who placed it. Payment-specific fields are filled according to the method used — boleto orders carry the boleto link and dates, Pix orders carry the Pix payload and its expiration.Primary key:
id