AskBiz|Help Centre
API & Developers·5 min read·Updated 1 February 2025

What You Can Build with the AskBiz API

Practical use cases for the AskBiz API — from embedding metrics in your own app to automating reports and building custom integrations.

Overview of the AskBiz API

The AskBiz API gives developers programmatic access to your business data, AI insights, and dashboard functionality. It is a REST API that returns JSON responses and uses API key authentication.

Base URL: https://api.askbiz.co/v1/

Full documentation is available at developers.askbiz.co. API access requires a Growth or Business plan.

Use case 1: Embedding metrics in your own app

If you have a custom internal tool, operations dashboard, or client-facing portal, you can embed AskBiz metrics directly.

Example: An agency builds a client reporting portal. They use the AskBiz API to pull each client's revenue, margin, and customer metrics and display them in a white-labelled dashboard under their own branding.

Relevant endpoints:

  • GET /metrics/revenue — total revenue for a given period
  • GET /metrics/margin — gross margin % for a given period
  • GET /customers/summary — key customer metrics (count, LTV, repeat rate)

Pagination, date range filtering, and channel filtering are supported on all metric endpoints.

Use case 2: Automated reporting

Instead of manually pulling reports, use the API to generate and send reports on a schedule.

Example: A weekly automated email to the CEO containing revenue, margin, and top products — pulled from AskBiz via API and formatted in your own email template.

Relevant endpoints:

  • GET /reports/weekly-summary — pre-built weekly summary
  • GET /products/top — top products by revenue for a given period
  • GET /alerts/recent — any alerts triggered in the last 7 days

Combine with a scheduled job (cron, GitHub Actions, AWS Lambda) to run the report automatically each Monday morning.

Use case 3: Custom data integrations

If you have a data source that AskBiz does not natively support, you can push data to AskBiz via the API for it to be included in your intelligence and dashboards.

Example: A business uses a custom-built POS system. They write a nightly script that exports the day's sales data from their POS database and pushes it to AskBiz via POST /data/import/orders.

Pushed data is treated identically to data imported from native integrations — it appears in your dashboards, P&L, and is available to the AI Chat.

Use case 4: Triggering AI insights programmatically

The AI Chat is available via API, allowing you to ask business questions programmatically and receive structured responses.

Example: A retailer builds an internal Slack bot. When a team member types '/askbiz revenue this week', the bot calls POST /ai/query with the question and posts the response back to the Slack channel — no need to open a browser.

Relevant endpoint: POST /ai/query

Request body: { "question": "What was my revenue this week compared to last week?" }

Response: structured JSON with the answer text and the underlying data used.

AI endpoint responses are rate-limited separately from data endpoints — see the Rate Limits article.

Frequently Asked Questions

Was this article helpful?

Still stuck? Email our support team.