API Reference
AppAdmin Panel
Start typing to search…

Search Data

Search Data API provides the ability to export Happeo data or index data from Happeo to customer's own index.

Introduction

This API is designed to provide dynamic access to Happeo's content, including posts, comments, channels and pages. Originally developed to support internal search functionalities and feed external search engines, this API is now available for use by selected customers to integrate Happeo data into their internal applications and workflows.

API Scope

The Search-Data API allows authorized users to:

  • Retrieve and query Happeo content, including:
    • Posts and their associated comments
    • Channels, along with details about members
    • Pages, including metadata and content elements
  • Access real-time data updates, enabling applications to receive the latest content changes without manual intervention.

Data Access and Updates

Real-Time Updates

Users can configure their applications to poll for data updates at regular intervals, from as frequently as hourly to daily, depending on their needs.

Data Export and Migration

In compliance with new European legislation, this API facilitates data exports that allow customers to migrate to other providers with minimal disruption.

Usage Guidelines

Endpoint Access

Detailed information on available endpoints, including parameters and output formats, can be found in the API documentation.

Rate Limiting

The default rate limit is set to 600 requests per 30 seconds. Please contact us if you require adjustments to this limit.

Getting Started

To begin using the Search-Data API, please follow these steps:

  1. Obtain an API Key: Before you can make any API requests, you'll need to obtain an API key which will be used to authenticate your requests. Detailed instructions on how to create an API key can be found here.
  2. Review the API Documentation: Familiarise yourself with the available resources and operations provided by our API by reviewing the documentation.
  3. Test Your Integration: Utilize the API in a test environment to ensure compatibility with your systems and to adjust to the rate limits and data formats.

Support and Feedback

Please report any issues, suggestions, or comments to our technical support team at [email protected].