SocialHub icon

SocialHub

SocialHub System API Integration Node

Overview

This node integrates with the SocialHub system API to perform a paginated query of points detail records for a specified points account. It is useful for retrieving detailed transaction history of points, including filtering by record status and date range. Practical applications include loyalty program management, auditing points transactions, and customer service scenarios where detailed points activity needs to be reviewed.

Use Case Examples

  1. Retrieve the first page of points transaction details for a customer's points account to display recent activity.
  2. Filter points records by status (e.g., only effective points) within a specific date range for reporting purposes.

Properties

Name Meaning
Points Account Code The unique code identifying the points account to query details for.
Page Number The page number of the paginated results to retrieve, starting from 1.
Page Size The number of records per page, with a maximum of 100.
Record Status Filter points records by their status: all, effective, not effective, or expired.
Start Time Optional start time to filter points records from this date/time onward.
End Time Optional end time to filter points records up to this date/time.

Output

JSON

  • data - The array or object containing the points detail records returned from the API.

Dependencies

  • Requires an API key credential for the SocialHub system API to authenticate requests.

Troubleshooting

  • Common issues include invalid or missing points account code, resulting in API errors or empty results.
  • Incorrect date formats for start or end time may cause the API to reject the request.
  • Exceeding the maximum page size of 100 may result in errors or truncated data.

Links

Discussion