Sign Up

API & MCP

Connect AI assistants and your own tools to PingAura with API keys or OAuth, and choose what each connection is allowed to do.

Use API & MCP when you want to work with your PingAura data outside the app. For example, you can ask Claude or Cursor about your visibility scores, or send website visit data from your own servers.

You will find it under Workspace settings → API & MCP.

Two ways to connect

  • OAuth. The app sends you to PingAura to sign in and approve access. No key to copy. Claude.ai, Claude Desktop, Claude Code and Cursor work this way. See Connecting apps with OAuth.
  • API key. You create a key in PingAura and paste it into the tool. Use this for tools that cannot open a browser, scripts, and the telemetry SDK.

Creating an API key

Only the workspace owner can create and revoke keys. Other members can see the list.

  1. Go to Workspace settings → API & MCP.
  2. Click Create API Key and give it a name you will recognise later, such as "Cursor on my laptop".
  3. Pick its Scopes:
    • Read: look at domains, prompts, articles, audits, visibility runs and other workspace data.
    • Write: create and change articles, prompts and competitors, run audits and sync sitemaps.
    • Ingest: send telemetry events only. It cannot read or change anything else. Use it for the telemetry SDK. Ingest cannot be combined with Read or Write.
  4. Pick an Expiration: 30 days, 90 days, 6 months, 1 year, or no expiration.
  5. Copy the key. It is shown once only, so store it in a password manager.

A revoked or expired key stops working straight away.

Pages in this section