API and exports

The API and integrations section takes Relator data elsewhere: Looker Studio and Power BI dashboards, spreadsheets and your own systems. Everything is read-only: no key creates, edits or publishes anything in the clients’ accounts.

Before you start

• Where it is: Settings › Agency group › API and integrations. In an own-business account, Settings › API and integrations, in the Your account group.
• Who uses it: the agency team (or the own-business account owner). Owner and Admin create and revoke keys; Member only views. Client people have no access to this section.
• Plan: the API is included in Scale and Enterprise. On Starter and Pro, it is unlocked by the API and MCP add-on. Without it, the section shows a sample screen and the way to unlock it.

What each tab holds

• API keys

  What it is for

  Create, list and revoke keys. It also shows the API URL, with a Copy button.

• Scheduled exports

  What it is for

  Send a CSV by email or to Google Drive every day, week or month, without a key.

• Looker Studio and Power BI

  What it is for

  Step-by-step guides for each tool and the Power BI feed URL, built from pickers.

• Usage

  What it is for

  How many requests the API received this month, against the plan limit.

Create a key

1. 1
   Step 1

   Open API and integrations

   Click Settings in the sidebar and, in the Agency group, API and integrations. Click New key.

   Illustrative screen

   Farol Agency/API and integrations

   Ask RelatorAIPT

   API & integrationsRead-only · 200,000 requests per month

   New key1

   API keysScheduled exportsLooker Studio and Power BIUsage

   Access keys

   Name	Access	Clients	Last used
   Looker Studio · Korra	Read	1 client	2 hours ago
   Power BI · all	Read + goals	All (6)	Never used

   2

   1. 1New key opens a 3-step creation.
   2. 2Each key shows what it reads, which clients and when it was last used. Revoke is on the row.

2. 2
   Step 2

   Say what it’s for

   Choose the purpose: Looker Studio, Power BI, Spreadsheet or Own system. Click Continue.

3. 3
   Step 3

   Choose what the key reads

   Then click Create key.

   • What it can read: Media metrics (Meta Ads, Google Ads, GA4), CRM and revenue (HubSpot, RD Station), Goals and SEO (Search Console).
   • Clients: pick from the searchable list or tick All clients (includes new ones).
   • Validity: 30 days, 1 year or No expiry.
   • Name: RelatorAI suggests a name from the purpose and clients. You can edit it.
4. 4
   Step 4

   Copy the key

   The Key created dialog shows the full key only once. Click Copy key and store it somewhere safe before clicking Done.

Use the key

• Looker Studio

  How to connect

  Create a key with the Looker Studio purpose, open Relator’s connector in Looker Studio, authorize and paste the key when it asks. If the Open the Looker Studio connector button is disabled with the Connector being published notice, use Power BI, CSV or scheduled exports until the connector is out.

• Power BI

  How to connect

  In the Looker Studio and Power BI tab, pick the client, source and format and copy the feed URL (last 30 days, one row per day). In Power BI, use Get data › OData (or Web), paste the URL and choose Basic authentication: any user name and the key as the password.

• Excel and spreadsheets

  How to connect

  Use the same feed URL in the CSV for Excel and spreadsheets format, or schedule the CSV in the Scheduled exports tab.

• Own system

  How to connect

  Call the API URL sending the key in the Authorization: Bearer header. To download a table, use /metrics with format=csv.

Limits and usage

• Each plan has a monthly request cap, shown at the top of the section and in the Usage tab: 50,000 per month on Starter and Pro (with the add-on) and 200,000 on Scale. On Enterprise, the limit is set by contract.
• The Usage tab shows the month’s total, the renewal date and the projection at the current pace.
• Past 90% of the limit, a notice shows at the top of the section and the agency owners get an email.
• Above the limit, the API answers with a 429 error until it renews. Scheduled exports don’t use a key.
• Keys unused for 90 days expire on their own, on top of the validity you chose.
• A key stops working if the person who created it leaves the agency or is no longer Owner or Admin.

Scheduled exports

1. 1
   Step 1

   Create the export

   In the Scheduled exports tab, click New export.

2. 2
   Step 2

   Choose destination and content

   • Destination: Email (CSV), choosing agency people in Who receives it, or Google Drive. For Drive, connect the account first with Connect Google Drive; Relator only sees the folder it creates itself.
   • Source: Meta Ads, Google Ads, Google Analytics 4, Search Console, HubSpot or RD Station.
   • Rows: by day or by campaign.
   • Clients and Name, as with keys.
3. 3
   Step 3

   Set the frequency and schedule

   Choose Every day, Every week (with the weekday) or Every month (with the day of the month) and the Time, in the time zone shown on screen. Click Schedule export.

• By email, a download link arrives. The link is valid for 7 days and requires signing in to Relator with the same agency.
• An expired link, one from another account or from a deleted export opens This download link is no longer valid. The next delivery sends a new link.
• When a delivery fails, the row shows Failed with the reason and a Try again button. If Drive lost access, use Reconnect Google Drive.
• Delete stops future deliveries. Files already sent stay where they are.

Revoke a key

In the API keys tab, click Revoke on the key’s row and confirm. Access stops on the next request and dashboards using the key stop refreshing. Revoke whenever someone who knows the key leaves the agency or the key shows up somewhere it shouldn’t.

What about webhooks?

Relator doesn’t send webhooks yet. In Settings › Notifications, the Signed webhook shows under Upcoming channels, marked Coming soon. To be warned about problems, use alerts and email notifications.

Availability by plan

Common issues

• I don’t see New key. Your role is Member. Ask an agency Owner or Admin.
• The section shows “Available from” a plan. The plan doesn’t include the API. Add the API and MCP add-on or move to Scale. See Add-ons.
• The dashboard stopped refreshing. The key was revoked, expired (validity or 90 days without use) or its creator left the agency. Create a new key and swap it in the dashboard.
• Error 429. The month’s limit is used up. The Usage tab shows when it renews.
• The feed URL doesn’t show. No client has a connected source. Connect a source for the client first.