Stats & User Data

Learn how to retrieve user statistics, points balances, and transaction history.

Overview

After users enroll and scan receipts, you can access their PlanetPoints data:

Get a snapshot of a user's overall PlanetPoints activity.

Endpoint: GET /users/{id}/summary

Response fields:

Field	Type	Description
`userID`	String	User's unique ID
`email`	String	User's email address
`lifetimePoints`	Number	Total points earned (all time)
`availablePoints`	Number	Current available balance
`numOfTransactions`	Integer	Number of receipts processed
`totalCarbonScore`	Number	Cumulative carbon impact score
`totalGreenProducts`	Integer	Count of eco-friendly products
`createdAt`	DateTime	Account creation date
`updatedAt`	DateTime	Last update timestamp

Retrieve all processed receipts for a user.

Endpoint: GET /users/{id}/transactions

Returns an array of transaction summaries including:

Get item-level breakdown for a specific transaction.

Endpoint: GET /users/{id}/transactions/{transaction_id}

Response includes:

Field	Type	Description
`transaction_id`	String	Transaction reference
`items`	Array	List of products with ratings
`total_amount`	Number	Receipt total
`total_points`	Number	Points earned

Item fields:

Convert numeric ratings to letter grades: