Public documentation for the Qloo API and platform. This repository contains all content from docs.qloo.com plus the OpenAPI specification.
The openapi-schema.json file contains the complete OpenAPI 3.1 specification for the Qloo API v2. You can import this file into tools like Postman, Swagger UI, or any OpenAPI-compatible client.
| Document | Description |
|---|---|
| Solutions Overview | Overview of Qloo's AI-powered solutions |
| Insights by Qloo | The Insights platform for non-technical users |
| Insights API | Overview of the Insights API |
| Document | Description |
|---|---|
| Affinity | What affinity scores are and why they are useful |
| Affinity Score Methodology | Data and process behind calculating affinity scores |
| Interpreting Affinity Scores | Guide to interpreting scores, ranges, and query behavior |
| Audiences | Understanding audience segments |
| Entities | Core entity concept in the Qloo ecosystem |
| Filters | Output filters for entity categories |
| Signal | Consumer interaction signals |
| Heatmaps | Geographic affinity visualization |
| Location Insights | Location-based consumer preferences |
| Document | Description |
|---|---|
| Navigating the Insights UI | Guide to the Insights by Qloo interface |
| Generating Insights | How to create insights and dashboards |
| Document | Description |
|---|---|
| Methodology and Sources | Overview of Qloo's methodology |
| Data Foundation | How Qloo collects and structures data |
| Processing Methodology | Signal processing and ML model application |
| Representative Data and Patterns | Sample co-occurrence data and correlations |
| FAQs | Frequently asked questions |
| Glossary | Key terms and definitions |
| Document | Description |
|---|---|
| API Overview | Introduction to the Insights API |
| API Onboarding and Authentication | Getting started with API keys and auth |
| API System Status | Service status information |
| API Information | General API metadata |
| Document | Description |
|---|---|
| Insights API Deep Dive | Interactive reference for the Insights endpoint |
| Parameter Overview | How to choose and format parameters |
| Parameter Reference | Complete parameter dictionary |
| Entity Type Parameter Guide | Parameters supported by each entity type |
| Legacy Parameter Mapping | Migration guide from v1 to v2 parameters |
| Document | Description |
|---|---|
| Key Use Cases | Overview of common API use cases |
| Recommendation Insights | Get top recommendations for any entity type |
| Demographic Insights | Retrieve demographic data for entities |
| Heatmap Insights | Generate heatmap data for location analysis |
| Location-Based Insights | Scope recommendations to specific locations |
| Taste Analysis | Retrieve tag-level insights |
| Document | Description |
|---|---|
| Entity Search | Search for entities by name or property |
| Entity Search by ID | Look up entities by ID |
| Find Audiences | Search for audience segments |
| Get Audience Types | List available audience types |
| Tags Search | Search for tags |
| Tag Types | Retrieve available tag types |
| Document | Description |
|---|---|
| Analysis Compare | Analyze and compare entity groups |
| Get Trending Data | Week-over-week trending data for an entity |
| Trending Entities | Currently trending entities by category |
| Week-Over-Week Trending | Detailed trending time series |
| Document | Description |
|---|---|
| Code Recipes | Ready-to-use API code examples |