API Reference

Documentation for the Appy Days REST API. Currently in development with early access available.

API Status

The Appy Days REST API is currently in early development. We plan to offer programmatic access to all core features, enabling merchants and developers to integrate Appy Days data into their own workflows and tools.

Planned Endpoints

The following endpoints are planned for the initial API release:

Reviews

  • GET /api/v1/reviews - List all reviews with filtering and pagination
  • GET /api/v1/reviews/:id - Get a single review
  • POST /api/v1/reviews - Create a review programmatically
  • PATCH /api/v1/reviews/:id - Update review status (approve, reject, feature)

Upsell Rules

  • GET /api/v1/upsell-rules - List all upsell rules
  • POST /api/v1/upsell-rules - Create a new rule
  • PATCH /api/v1/upsell-rules/:id - Update a rule
  • DELETE /api/v1/upsell-rules/:id - Delete a rule

Analytics

  • GET /api/v1/analytics/overview - Dashboard summary metrics
  • GET /api/v1/analytics/reviews - Review module analytics
  • GET /api/v1/analytics/upsells - Upsell performance data

Authentication

The API will use OAuth 2.0 authentication through the Shopify app authorization flow. API keys will be available in the Appy Days dashboard under Settings > API.

Rate Limits

Planned rate limits: 100 requests per minute per store. Bulk endpoints will be available for high-volume operations.

Early Access

If you are interested in early access to the API, contact us at api@appydays.co. We are accepting a limited number of partners for the beta program.