HTTPS
Estimated time: 2 mins

How to connect Custom API to ARIQ

Use this guide when an agency connects a client's Custom API account, or when a business connects its own Custom API account. The connection is saved on the open project.

Credential format:https://api.yourdomain.com/metrics

Who connects Custom API

The connection is saved on one project. An agency connects each client from that client's project. A business connecting its own account uses its own project. Both follow the same Connect button.

Agency

Sign in to ARIQ with your agency user. Open the client project, then connect that client's Custom API account. The client does not need an ARIQ login. Use the Custom API login that can already see that client's data.

Your own business

Sign in to ARIQ, open your project, and connect the Custom API account this business already uses. You approve access with that same account.

Connect it inside ARIQ

  1. 1Sign in to ARIQ.
  2. 2Open the project this account belongs to. Switch projects from the left sidebar if you manage more than one client.
  3. 3Open Custom API from the workspace tabs, or go straight to the Custom API page.
  4. 4Click Connect. ARIQ asks for the webhook URL from Custom API. Paste that URL and save it on this project.
  5. 5Stay on that project and sync. The page shows live numbers only after this account is connected. Another client's project stays empty until you connect it there too.

On Custom API, before you click Connect

Do this in the Custom API account that belongs to the client, or in your own account if this project is your business. Then come back to ARIQ and click Connect.

1

Expose a JSON endpoint

HTTP reference

The URL must be public HTTPS and return JSON. Include the metrics you want on the dashboard.

2

Paste the URL

On the Custom API page, paste the full URL, including any token query parameter your endpoint expects.

3

Connect and sync

ARIQ requests the URL and stores a successful response as the custom data source.

What shows up after the account is connected

Point ARIQ at any HTTPS endpoint that returns JSON metrics for a client.

HTTP statusJSON payload
Before you connect
  • Do not point this at a private IP. The ARIQ server must be able to reach the URL.

Connect this account now

Open the project, then open Custom API and click Connect. The account you approve is the one ARIQ reads for that project.

Previous TopicMakeNext Topic WordPress