Welcome to Caplena’s Documentation

This site covers Caplena’s usage & API documentation. To learn more about what you can use Caplena for and how to create your own API key, please see our main website.

Getting Started

If you are trying to get started as quickly as possible, this part of the documentation is for you.

• Getting Started
  • Installation
    • Minimum Version
    • Dependencies
    • Installing Caplena
  • Your First API Request

Creating Projects and adding rows

Learn how to create projects and upload your data to Caplena.

• Creating Projects and adding rows
  • Creating the project
  • Appending rows

Retrieving Projects and results

Understand how to fetch previously uploaded data and how to access the results of the analysis performed by Caplena.

• Retrieving data and results
  • Retrieving projects
  • Retrieving Upload status
    • Filtering examples
    • Retrieving topics
  • Retrieving rows
    • Filtering rows
  • Retrieving row values
  • Retrieving analysis results

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API Reference
  • Client
  • Controllers
  • Resources
  • Filters
  • Iterator
  • Exceptions