Xgate Cdp icon

Xgate Cdp

Consume Xgate Cdp API

Segment → Query Customer

AI-generated

Overview

This node interacts with the Xgate Cdp API to query customers within a specified segment. It is useful for retrieving paginated customer data from a particular segment, allowing users to specify the segment by name or ID, and control the number of results per page and the page number. Practical applications include segment-based customer analysis, targeted marketing campaigns, and customer data management.

Use Case Examples

  1. Retrieve the first page of customers from a specific segment with 20 results per page.
  2. Fetch the third page of customers from a segment identified by its ID, with 50 results per page.

Properties

Name Meaning
Segment Name or ID Specifies the segment from which to query customers. Can be selected from a list or provided as an ID expression.
Page Size Defines the number of customer results to return per page.
Page Number Specifies which page of results to retrieve, enabling pagination through customer data.

Output

JSON

  • segmentId - The ID of the segment queried.
  • pageSize - The number of results returned per page.
  • pageNumber - The current page number of the results.
  • customers - Array of customer data objects returned from the segment query.

Dependencies

  • Xgate Cdp API
  • An API key credential for authentication

Troubleshooting

  • Common issues include invalid segment ID or name, resulting in API errors or empty results.
  • Incorrect page size or page number values may cause unexpected pagination behavior or errors.
  • API request failures due to network issues or invalid credentials will throw errors; ensure valid API key and network connectivity.

Discussion