Segments

This topic describes what segments are and how to use them. Use segments to create your own custom view on data.

A segment is a filtered view of a data set. By default, there are four segment types: Customer, Payments, Billing, and Logs. Within segment type, data is filtered into segments which are provided by default. For information on these segments, and how they are filtered, see Manage customers, Manage payments, Manage Billing, or Manage logs.

Create a new segment

Use this process to create a new segment which will be displayed in data tables, inside one of the following segment types: Customer, Payments, Billing, or Logs.

  1. In the left navigation bar, click Data tables icon , click Segments , then click Add new segment .
  2. Select one of the following options:
    • Add a new segment to the data tables page: In the Page dropdown, select Data tables .
    • Add a new segment to the customer detail page: In the Page dropdown, select Customer .
      Note

      To access the customer details page: In the left navigation bar, click Data tables icon, click Customers, then in the Name column, click a customer's name. To enable segments in the customer detail page, select the Show segments slider.

  3. In the Type dropdown, select the data type. New segment types are displayed under the following segment types:
    • Customers: Customers.
    • Payments: Transactions.
    • Billing: Invoices, orders, coupon redemptions, credit memos.
    • Logs: API logs, webhooks logs.
  4. In the Share section:
    • To make the segment visible to all users, select All users .
    • To make the segment visible to you only, select Private .
    • To make the segment visible to specific users, select Specific users , then in the dropdown, select the users or user groups.
  5. In the Title field, enter a name for the new segment.
  6. In the Filters section, add one or more filters. Use filters to add additional conditions to the data that is displayed in the segment. You can add multiple filters to a segment.
  7. In the Columns section, add, remove, and arrange columns.
  8. In the Default sort order section, select a sort order and a column to based the order upon.
  9. Click Save segment .
  10. In the Title column, click the new segment.

Edit a segment

Use this process to edit an existing segment.

  1. In the left navigation bar, click Data tables icon , then depending on where the segment is located, click Customers , Payments , Billing , or Logs .
  2. Click the segment.
  3. Select from the following:
    • Edit or reorder columns in the table:
      1. In the top right of the table, click Columns icon .
      2. Select an option:
        • To edit or change columns: In the top of the new window, click Select columns , then select the columns that you want in the table.
        • To reorder columns: In the top of the new window, click Arrange columns , then drag the items to arrange the order.
      3. Click Apply .
    • Add a new filter:
      1. Select a segment, then at the top of the table, click Filter icon .
      2. In the first dropdown, select a value to filter.
      3. In the second dropdown, select a conditional.
      4. Depending on the data selected in the previous steps, enter or select additional values.
    • Edit an existing filter:
      1. At the top of the table, click Filter icon .
      2. Edit the filter, then click Save .
    • Delete a filter:
      1. At the top of the table, click Filter icon .
      2. On the right of the filter, click Delete icon .

    • Sort data:
      In the table header, click a column heading. Table headings that have been sorted display a down arrow Arrow down icon , or a up arrow Arrow up icon which indicates the sort order, and that a sort has been applied.

  4. Click Save , or to create a new segment based on the changes, click Save segment as .

Manage segments

Use this process to: adjust who can access or see a segment, favorite a segment, edit a segment, or to view and edit segment data.

  1. The manage segments option is accessible from two locations, select one of the following:
    • From data tables:
      1. In the left navigation bar, click Data tables icon .
      2. In the left of the screen, in the Data tables section, click Manage segments .
    • From settings:
      1. In the left navigation bar, click Settings icon , then click Segments .
      2. Depending on where the segment is located, click Data tables or Customer details .

  2. Select Customers , Payments , Billing , or Logs .
  3. Select from the following segment options:
    • Adjust who can access a segment: In the Shared with column, click the status, make a selection, then click Apply .
    • Turn segment visibility on or off: In the Visibility column, click the slider.
    • To favorite a segment: In the Starred column, select or clear the Star icon icon.
    • Delete a segment: On the right of a segment, click Delete icon .
    • View and edit segment data: In the Title column, click the segment name. To edit a segment, see Edit a segment .

Apply a filter to an existing segment

Use this process to apply a filter to an existing segment.

A filter is a means of refining data that is displayed in a data table. You can create multiple filter combinations to create a custom view on your data. To add more than one filter to an existing segment, repeat the following process.

  1. In the left navigation bar, click Data tables icon , then click Customer , Payments , Billing , or Logs .
  2. Select a segment, then at the top of the table, click Filter icon .
  3. In the first dropdown, select a value to filter.
  4. In the second dropdown, select a conditional.
  5. Depending on the data selected in the previous steps, enter or select additional values.
  6. Select an option:
    • To save the filtered data to the active segment: Click Save .
    • To create a new segment based on the filtered data: Click Save segment as , enter a name for the new segment, then click Save .

Edit a filter on an existing segment

Use this process to edit a filter that is applied to a segment.

A filter is a means of refining data that is displayed in a data table.

  1. In the left navigation bar, click Data tables icon , then click Customer , Payments , Billing , or Logs .
  2. Select a segment, then at the top of the table, click Filter icon .
  3. Edit the filter, then click Save .

Related topics