Akkio Docs
  • Akkio Documentation
    • Akkio FAQ
  • Account and Settings
    • Team Settings
    • Organization Settings
    • Account Settings
    • Role Based Access Control
  • Demo Models
    • Demo Models
      • Lead Scoring
      • Retail Sales Forecasting
      • Predict Credit Card Fraud
      • Identify Customer Churn
  • Setting up Integrations
    • Connecting Data
    • Airtable (Beta)
    • Google Ads (Beta)
    • Google Analytics 4 (Beta)
    • Google BigQuery
    • Google BigQuery (Service Account)
    • Google Sheets
    • HubSpot (Beta)
    • MariaDB (Beta)
    • MongoDB (Beta)
    • MySQL (Beta)
    • PostgreSQL (Beta)
    • Redshift (Beta)
    • Salesforce
    • Akkio Data Chat for Slack
    • Snowflake (Username / Password) (Beta)
    • Zapier
  • Prepare your Data
    • Prepare
      • Chat Data Prep
      • Clean
      • Merge & Fuzzy Merge
      • Table View
      • Pivot View
      • Deploying Chat Data Prep
  • Explore
    • Chat Explore
    • Chart Types
  • Building a Model
    • Predict
      • Insights Report - Classification
      • Insights Report - Regression
    • Forecasting
      • Insights Report - Forecasting
    • Model Types
  • Deploying a Model
    • Deploy
      • Google BigQuery
      • Google Sheets
      • HubSpot (Beta)
      • PostgreSQL (Beta)
      • Salesforce
      • Snowflake (Beta)
      • Web App
      • Zapier
  • REPORTING AND SHARING
    • Reports
    • Dashboards
  • REST API
    • API Introduction
      • Quickstart
    • API Options
      • cURL Commands
      • Python Library
      • Node.js Library
    • API FAQ
  • Rest API (v2)
    • Documentation
Powered by GitBook
On this page

Was this helpful?

  1. REST API

API Introduction

What is the API and how do I get started?

The Akkio API is designed to be a 1:1 parity of our web interface. Anything that can be achieved visually can also be called in the API. This section provides an introduction on how to set up and test the setup of the API as well as a list of the commands available for use with example syntax.

For beginners, we recommend running the quick start to ensure that your setup is correct, as it is a solution on rails that will ensure you are starting from a good state.

If you have any issues with commands that may need to be added to the API or the documentation, we are happy to work with you to either point you to the right place or implement any required updates. Contact our support through our in-app chat or at support@akkio.com.

PreviousDashboardsNextQuickstart

Last updated 1 year ago

Was this helpful?