Syncaty SallaInstall

Summary

Retrieve customers belonging to a specific segment in a selected Salla store, optionally including detailed metrics for each customer.

Inputs

• Store (required) — Select the Salla store to operate on
• Segment ID (required) — The ID of the segment from which to get customers
• Return All — Whether to return all customers in the segment or limit the number returned
• Limit — Maximum number of customers to return when not returning all (default 25, max 100)

Output shape

a list of customer records within the specified segment, each including customer metrics

If 'Return All' is set to true, all customers from the segment are returned by paging through all pages. If false, the number of customers is limited up to the specified 'Limit'. Returned data includes a 'customers' array with detailed customer data.

Examples

Example 1: Get up to 50 customers from segment with ID '12345' in store 'StoreA'

Set 'Store' to 'StoreA', 'Segment ID' to '12345', 'Return All' to false, and 'Limit' to 50.

Example 2: Get all customers from a segment

Set 'Return All' to true to retrieve every customer in the segment regardless of count.