Plugsight

API reference · Pro & Agency

Plugsight API

Read live data from your business tools (ads, analytics, helpdesk, email, store, calendar) with one key and one JSON API. You connect each account once in Plugsight; you never build OAuth apps, store tokens or learn ten different APIs.

How it works

Your code sends a normal HTTPS request with your key. Plugsight calls Google, Zendesk, Shopify-style stores and the rest for you, live, and answers in JSON.

  1. Connect your accountsSign in to Google Ads, Zendesk, your mailbox and so on, once, in the Plugsight app.
  2. Choose what the key can reachGroup the accounts into a project and create its API key.
  3. Call the APIAsk for a tool by name, such as get_marketing_data, and get its data back.

There is nothing to install and no SDK: any language that can send an HTTPS request works.

Words we use

Connection
An account you've linked, for example your Google Ads account or a Zendesk helpdesk. You add them under Connections in the app.
MCP server (your API project)
A named group of connections with its own key. The app calls it an "MCP server" because AI apps like Claude and ChatGPT use the same thing through a standard called MCP. For the API, think of it as a project: you don't need to know anything about MCP. Make one per website or system, so each key reaches only what it needs.
API key
The secret that identifies your project. It starts with mcpk_. Each project has one; making a new one turns the old one off.
Tool
One thing the API can do, like "list Zendesk tickets" or "get Google Ads spend by campaign". Each has a name, arguments and an answer. The tools you get depend on the connections in the project: add Zendesk and the Zendesk tools appear.
Read and Change
Read tools only fetch data. Change tools do something, like send an email or update a ticket, and need extra permission (see below).

Quick start

About 5 minutes. You need a Plugsight account on the Pro or Agency plan.

  1. Connect an account. Open Connections in the app and connect what you want data from, for example Google Analytics.
  2. Create a project for your key. Open MCP servers → Create MCP server. Name it after where you'll use it (say "Company website"), then under Account access pick Selected accounts and tick only the ones this key should reach. Untick "Allow changes" if the key only needs to read.
  3. Create the API key. On the project's page, find API key → Create API key, and copy it straight away: it's shown only once. Save it as an environment variable on your server, for example:
    export PLUGSIGHT_API_KEY="mcpk_…"
  4. See what you can call.
    curl https://app.plugsight.app/v1/tools \
      -H "Authorization: Bearer $PLUGSIGHT_API_KEY"

    You get the list of tools this key can use, each with its arguments:

    {
      "tools": [
        {
          "name": "list_accounts",
          "title": "List connected accounts",
          "description": "Lists the accounts this MCP can use…",
          "read_only": true,
          "input_schema": { "type": "object", "properties": {} }
        },
        …
      ]
    }
  5. Find your account ids.
    curl -X POST https://app.plugsight.app/v1/tools/list_accounts \
      -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
      -H "Content-Type: application/json" -d '{}'
    {
      "data": [
        { "id": "google-analytics", "label": "Acme Ltd", "type": "marketing", "provider": "google_analytics", "changes": "read-only" },
        { "id": "zendesk", "label": "Acme Support", "type": "helpdesk", "provider": "zendesk", "site": "acme.zendesk.com", "changes": "off (read-only)" }
      ]
    }
  6. Get real data. Last 30 days of website sessions by day:
    curl -X POST https://app.plugsight.app/v1/tools/get_marketing_data \
      -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"connector": "analytics", "fields": ["date", "sessions", "users"], "date_preset": "last_30d"}'
    {
      "data": {
        "connector": "Google Analytics",
        "date_range": { "from": "2026-10-17", "to": "2026-11-15" },
        "accounts": ["acme.com (properties/123456789)"],
        "columns": ["date", "sessions", "users"],
        "rows": [["2026-10-17", 412, 388], ["2026-10-18", 455, 419], …],
        "row_count": 30,
        "totals": { "sessions": 13240, "users": 11872 }
      }
    }

    Answers are shown shortened. The exact fields for each tool are in the tool reference.

Authentication

Send your key in the Authorization header of every request:

Authorization: Bearer mcpk_…
  • Keep it on your server. Anyone with the key can read what its project reaches. Never put it in web page code, a mobile app or a public repository. The API sends no CORS headers, so browsers can't use it directly anyway.
  • One key per project. Regenerate key on the project's page makes a new one and turns the old one off at once; Revoke key turns it off.
  • Least access. A key reaches only its project's connections, minus anything you've hidden in the app.

Requests and responses

Base URLhttps://app.plugsight.app/v1 (HTTPS only)
Run a toolPOST /v1/tools/<tool name>. The JSON body is the tool's arguments. Send {} when it takes none.
HeadersAuthorization: Bearer <key> and Content-Type: application/json
SuccessStatus 200 with { "data": … }. What's inside data depends on the tool: usually an object or a list.
FailureStatus 4xx/5xx with { "error", "message", "docs" }. See Errors.
DatesYYYY-MM-DD; date-times in ISO 8601 with an offset, e.g. 2026-11-20T15:00:00+00:00.
PagingTools with many results take limit and page, offset or page_token; each tool's arguments say which.
FreshnessLive: each call reads from the source at that moment. Nothing is stored by Plugsight; a few lists, such as which accounts a connection reaches, are kept in memory for a few minutes.

Choosing an account

Many tools take an account argument. Get the ids from list_accounts. If the project has only one account of that kind, you can leave it out. Marketing tools use list_marketing_accounts for their sites, properties and ad accounts, and take them as accounts (leave it out for all).

Making changes

Change tools (send or reply to email, update or create a ticket, book a meeting) only run when all of these are true:

  1. The request includes "confirm": true. This stops a change happening by accident: set it only once your own code or user has decided to go ahead.
  2. The project allows changes: Allow changes is ticked on its page.
  3. The connection allows changes (set on Connections), changes aren't paused, and the daily limit hasn't been reached.
curl -X POST https://app.plugsight.app/v1/tools/zendesk_add_comment \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id": 1042, "body": "Thanks, your refund is on its way.", "public": true, "confirm": true}'

If one isn't met you get 400 tool_error saying which. Every change appears in Activity in the app.

Errors

{
  "error": "tool_error",
  "message": "Unknown Zendesk account \"desk-2\". Call list_accounts to see valid ids.",
  "docs": "https://plugsight.app/developers"
}
StatuserrorWhat happenedWhat to do
400tool_errorThe tool couldn't run: a wrong or missing argument, a change not allowed, or the provider said no.Read message; it says what to fix.
401unauthorizedThe key is missing, mistyped, regenerated or revoked.Check the header, or create a new key.
403plan_requiredThe account isn't on Pro or Agency.Upgrade under Billing in the app.
404unknown_toolThe project has no tool by that name, often because the connection it needs isn't in the project.GET /v1/tools lists what it has.
404not_foundThe address isn't an API endpoint.Use one of the endpoints.
429rate_limitedOver 120 requests in a minute for this project.Wait the Retry-After seconds, then retry.
500server_errorSomething broke on our side.Retry; if it keeps happening, contact support.

Limits

  • 120 requests a minute per project. Need more? Use a second project, or cache results on your side.
  • Plans: the API is on Pro and Agency. Your plan's connection limits and features (such as marketing data) apply as they do in AI apps.
  • Providers' own limits still apply (Google Ads, Zendesk and so on). If one says "slow down", you get a tool_error explaining it.

Endpoints

GET /v1/tools

Lists the tools this key can use. Each has name, title, description, read_only and input_schema (a JSON Schema of its arguments). Handy for checking what a project can do, or for building forms.

POST /v1/tools/{name}

Runs one tool. The body is its arguments as a JSON object. Answers { "data": … }.

Tool reference

Every tool, grouped by the connection it needs. A project only has the groups for the connections in it. Tap a tool to see its arguments and an example. This list is generated from the API itself, so it's always current.

Accounts 1 tool

Needs: Always available

list_accountsReadList connected accounts

Lists the accounts this MCP can use (mailboxes such as Gmail, Outlook, iCloud; helpdesks such as Zendesk; marketing logins for Google Search Console/Analytics/Ads, Microsoft Advertising, Tag Manager, YouTube and Merchant Center; Google Drive and Sheets; Google, iCloud or Outlook Calendar and Contacts; WooCommerce and Magento stores; Mailchimp), their type, and whether each may send or make changes. Use the returned id in other tools.

No arguments: send {}.

Example request

curl https://app.plugsight.app/v1/tools/list_accounts \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Email 9 tools

Needs: Gmail, Outlook, iCloud Mail, Yahoo or any IMAP mailbox

list_foldersReadList folders

Lists folders/labels of one account with message and unread counts.

ArgumentTypeWhat it is
account requiredstringAccount id from list_accounts

Example request

curl https://app.plugsight.app/v1/tools/list_folders \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID"}'
search_emailsReadSearch / list emails

Lists or searches emails across one or all accounts. All filters combine with AND; a list (e.g. from: ["a@x.com", "b@y.com"]) matches any entry. With no filters it lists the latest inbox emails. Results include a short preview and the attachment list. query is a text match; on Gmail accounts it also accepts Gmail search syntax (e.g. "from:amazon newer_than:7d"), on Outlook accounts Outlook search syntax (e.g. "from:amazon AND received>=2026-01-01"). Searches run live against each mail server and cover the whole mailbox history. For "find all" questions, keep paging with offset until no more results come back. When more_per_account lists an account, its results are incomplete or can continue: follow its note, e.g. call again for that account with cursor: next_cursor.

ArgumentTypeWhat it is
accountstringAccount id, or "all" (default)
folderstringFolder path from list_folders, or: inbox (default), sent, drafts, trash, junk, archive, all (every folder except trash/junk)
querystringFree text anywhere in the email
fromstring or array of stringSender name/address contains (string or list, any match)
tostring or array of stringRecipient (To) contains
ccstring or array of stringCc contains
bccstring or array of stringBcc contains (only visible on emails you sent)
subjectstringSubject contains
bodystringBody contains
exclude_fromstring or array of stringLeave out emails from these senders
exclude_subjectstringLeave out emails whose subject contains this
exclude_textstringLeave out emails containing this text
sincestringOn or after this date, YYYY-MM-DD
beforestringBefore this date, YYYY-MM-DD
unreadbooleantrue = only unread, false = only read
flaggedbooleantrue = only flagged/starred, false = only unflagged
answeredbooleantrue = only emails you replied to, false = not replied
has_attachmentbooleantrue = has real attachments (images embedded in the body don't count), false = none
attachment_namestringAn attachment's filename contains this
attachment_typestringHas an attachment of this type: pdf, image, document, spreadsheet, presentation, calendar, archive, email, audio, video, or a file extension
larger_than_kbnumberEmail size above this many KB
smaller_than_kbnumberEmail size below this many KB
sortstringSort order One of: newest, oldest. Default "newest".
include_previewbooleanInclude a ~200 character body preview Default true.
limitintegerMost results to return Default 20.
offsetintegerSkip this many results (pagination) Default 0.
cursorstringnext_cursor from an earlier result (Outlook): continues that search where it stopped. Needs the same account and filters; offset must be 0

Example request

curl https://app.plugsight.app/v1/tools/search_emails \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
get_emailReadRead an email

Returns the full email: headers, body text and the attachment list. Images embedded in the body are listed with inline: true and marked in the text as [inline image #N]; read them with get_attachment. Links in HTML emails are kept as "text (url)". Does not mark the email as read.

ArgumentTypeWhat it is
account requiredstringAccount id from list_accounts
email_id requiredstringEmail id from search_emails
include_htmlbooleanAlso return the raw HTML body Default false.
include_headersbooleanAlso return all raw headers (e.g. List-Unsubscribe, Received, authentication results) Default false.
max_charsintegerTruncate body to this many characters Default 20000.

Example request

curl https://app.plugsight.app/v1/tools/get_email \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","email_id":"…"}'
get_threadReadRead a conversation

Returns every email in the same conversation as the given email, oldest first.

ArgumentTypeWhat it is
account requiredstringAccount id from list_accounts
email_id requiredstringEmail id from search_emails
max_chars_per_emailintegerLongest email text returned; longer ones are cut Default 5000.

Example request

curl https://app.plugsight.app/v1/tools/get_thread \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","email_id":"…"}'
get_attachmentReadRead an attachment

Reads one attachment, including images embedded in the body. attachment is the index from get_email; for files inside a forwarded email (.eml) or Outlook winmail.dat use a path like "2.0". Returned as text for PDF, Word (.docx), Excel (.xlsx), PowerPoint (.pptx), HTML, CSV and other text files; as an image for images. Use mode "base64" to get the raw file instead.

ArgumentTypeWhat it is
account requiredstringAccount id from list_accounts
email_id requiredstringEmail id from search_emails
attachment requiredinteger or stringIndex from get_email (e.g. 0), or a nested path (e.g. "2.0")
modestringauto: text when the file can be read as text; base64: the raw file One of: auto, base64. Default "auto".
max_charsintegerTruncate extracted text Default 50000.

Example request

curl https://app.plugsight.app/v1/tools/get_attachment \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","email_id":"…","attachment":1}'
create_draftChangeCreate a draft

Saves an email as a draft in the account's Drafts folder; nothing is sent. Supports new emails, replies (reply_to_email_id, reply_all) and forwards (forward_email_id), with attachments uploaded as base64 or copied from another email.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
account requiredstringAccount id to send from (list_accounts)
tostring or array of stringRecipients: address or "Name <address>" (string or list)
ccstring or array of stringCc recipients: address or list
bccstring or array of stringBcc recipients: address or list
subjectstringSubject. Defaults to "Re: …" / "Fwd: …" for replies and forwards
body requiredstringPlain-text body. For replies/forwards the original is quoted below it automatically
reply_to_email_idstringReply to this email (sender is added as recipient, threading kept)
reply_allbooleanWith reply_to_email_id: also include the original To and Cc Default false.
forward_email_idstringForward this email, including its attachments
attachmentsarray of objectFiles to attach: email_id + attachment index from an email, or name + base64 content

Example request

curl https://app.plugsight.app/v1/tools/create_draft \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","body":"…","confirm":true}'
send_emailChangeSend an email

Sends an email immediately (new, reply or forward). Sending must be allowed for the account and this MCP in the app, and is limited per day; if blocked, offer create_draft instead.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
account requiredstringAccount id to send from (list_accounts)
tostring or array of stringRecipients: address or "Name <address>" (string or list)
ccstring or array of stringCc recipients: address or list
bccstring or array of stringBcc recipients: address or list
subjectstringSubject. Defaults to "Re: …" / "Fwd: …" for replies and forwards
body requiredstringPlain-text body. For replies/forwards the original is quoted below it automatically
reply_to_email_idstringReply to this email (sender is added as recipient, threading kept)
reply_allbooleanWith reply_to_email_id: also include the original To and Cc Default false.
forward_email_idstringForward this email, including its attachments
attachmentsarray of objectFiles to attach: email_id + attachment index from an email, or name + base64 content
confirm requiredbooleanMust be true: the user has seen this exact email and explicitly approved sending it

Example request

curl https://app.plugsight.app/v1/tools/send_email \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","body":"…","confirm":true}'
organize_emailsChangeArchive, label or mark emails

Changes up to 100 emails at once: mark read or unread, flag or unflag, add or remove labels (Gmail labels, Outlook categories), and move them (move_to: "archive", "trash", "inbox", "junk" or a folder from list_folders). Use ids from search_emails. Before moving to trash, or changing more than 10 emails, say what will happen and get a yes first.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
account requiredstringAccount id from list_accounts
email_ids requiredarray of stringEmail ids from search_emails or get_thread
readbooleantrue = mark read, false = mark unread
flaggedbooleantrue = flag/star, false = remove the flag
add_labelsarray of stringGmail labels or Outlook categories to add (created if new)
remove_labelsarray of stringLabels or folders to remove
move_tostring"archive", "trash", "inbox", "junk", or a folder path from list_folders

Example request

curl https://app.plugsight.app/v1/tools/organize_emails \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","email_ids":[],"confirm":true}'
send_draftChangeSend a draft

Sends an existing draft (from create_draft, or found in the drafts folder) and removes it from Drafts. Read it with get_email first.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
account requiredstringAccount id from list_accounts
draft_id requiredstringEmail id of the draft
confirm requiredbooleanMust be true: the user has seen this exact draft and explicitly approved sending it

Example request

curl https://app.plugsight.app/v1/tools/send_draft \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"ACCOUNT_ID","draft_id":"…","confirm":true}'

Zendesk 12 tools

Needs: A Zendesk connection

zendesk_search_ticketsReadSearch Zendesk tickets

Searches tickets with Zendesk search syntax, e.g. "status:open", "requester:jane@acme.com", "assignee:me status<solved", "tags:refund created>2026-01-01", or plain words. Newest updated first. Zendesk search returns at most the first 1,000 matches (pages past that fail); for larger sets narrow the query, e.g. by created or updated date, and use zendesk_ticket_stats for counts.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
querystringZendesk search query (type:ticket is added automatically)
sort_bystringField to sort by One of: updated_at, created_at, priority, status. Default "updated_at".
sort_orderstringasc or desc One of: desc, asc. Default "desc".
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.

Example request

curl https://app.plugsight.app/v1/tools/zendesk_search_tickets \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
zendesk_get_ticketReadRead a Zendesk ticket

Returns a ticket with requester, assignee, CCs and followers, organisation, group, brand, form, satisfaction rating, custom fields (by name, with drop-down option names) and the full conversation (public replies and internal notes, oldest first). For email, source shows which address wrote and which support address received it. Side conversations (separate email/Slack threads started from the ticket) aren't included; read them with zendesk_get_side_conversations. Each comment lists its files, numbered from 0, including images pasted into the reply (inline: true, marked in the text as [inline image #N]). Open any of them, e.g. a customer's screenshot or a PDF, with zendesk_get_attachment. Zendesk trims the quoted earlier messages from email replies; when a comment came by email (via: email), read the full email as received, quoted thread included, with zendesk_get_original_email.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
include_commentsbooleanInclude the ticket's comments Default true.
max_chars_per_commentintegerLongest comment text returned; longer ones are cut Default 4000.

Example request

curl https://app.plugsight.app/v1/tools/zendesk_get_ticket \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1}'
zendesk_get_attachmentReadRead a Zendesk attachment

Opens a file from a ticket comment, including images pasted into the reply (screenshots). comment_id and attachment (the file's index) come from zendesk_get_ticket. Images are returned as images, so you can look at them; PDF, Word (.docx), Excel (.xlsx), PowerPoint (.pptx), HTML, CSV and other text files as text. For a file inside an attached email (.eml) use a path like "1.0". Use mode "base64" for the raw file.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
comment_id requiredintegerComment id from zendesk_get_ticket
attachment requiredinteger or stringFile index from zendesk_get_ticket (e.g. 0), or a path inside an attached email (e.g. "1.0")
modestringauto: text when the file can be read as text; base64: the raw file One of: auto, base64. Default "auto".
max_charsintegerTruncate extracted text Default 50000.

Example request

curl https://app.plugsight.app/v1/tools/zendesk_get_attachment \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1,"comment_id":1,"attachment":1}'
zendesk_get_original_emailReadRead the original email

For a comment that arrived by email, returns the email exactly as Zendesk received it, including the quoted earlier messages below the reply, which Zendesk removes from the comment. Use it when the quoted thread matters (what was said before, a forwarded message, the customer's signature). comment_id comes from zendesk_get_ticket.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
comment_id requiredintegerComment id from zendesk_get_ticket
max_charsintegerTruncate the email text Default 30000.

Example request

curl https://app.plugsight.app/v1/tools/zendesk_get_original_email \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1,"comment_id":1}'
zendesk_find_usersReadFind Zendesk users

Finds people (customers or agents) by name, email or phone, with their phone and organisation. Shows up to 50; has_more says when more match, so narrow the search. Use the id for assignee changes.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
query requiredstringSearch text

Example request

curl https://app.plugsight.app/v1/tools/zendesk_find_users \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"…"}'
zendesk_get_side_conversationsReadRead a ticket's side conversations

Side conversations on a ticket: separate email, Slack or child-ticket threads an agent started (e.g. asking a supplier or another team), with every message in each, oldest first. They aren't part of zendesk_get_ticket. Needs Zendesk's Collaboration add-on or Suite Professional or above.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
max_chars_per_messageintegerLongest message text returned; longer ones are cut Default 4000.

Example request

curl https://app.plugsight.app/v1/tools/zendesk_get_side_conversations \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1}'
zendesk_add_commentChangeReply or add a note

Adds a public reply (emailed to the requester) or an internal note to a ticket, optionally changing its status. Internal notes are only seen by agents. Needs changes allowed for this Zendesk account and MCP server.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
body requiredstringText of the reply or note
public requiredbooleantrue = public reply to the customer, false = internal note
statusstringAlso set the ticket status One of: open, pending, hold, solved.
confirm requiredbooleanMust be true: the user approved this exact text

Example request

curl https://app.plugsight.app/v1/tools/zendesk_add_comment \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1,"body":"…","public":true,"confirm":true}'
zendesk_update_ticketChangeUpdate a Zendesk ticket

Changes a ticket's status, priority, type, assignee or tags. Needs changes allowed for this Zendesk account and MCP server.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
statusstringStatus One of: new, open, pending, hold, solved, closed.
prioritystringPriority One of: low, normal, high, urgent.
typestringType One of: question, incident, problem, task.
assignee_idintegerAgent user id (zendesk_find_users)
add_tagsarray of stringTags to add
remove_tagsarray of stringTags to remove
confirm requiredbooleanMust be true: the user approved these exact changes

Example request

curl https://app.plugsight.app/v1/tools/zendesk_update_ticket \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1,"confirm":true}'
zendesk_ticket_statsReadZendesk ticket counts

Counts tickets for a quick overview: open, pending, on hold, new and unsolved right now, plus created and solved in a period. Narrow it with a Zendesk query, e.g. "tags:refund", "group:Billing" or "assignee:me". For trends, call it for each period.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
from requiredstringPeriod start, YYYY-MM-DD
to requiredstringPeriod end, YYYY-MM-DD (inclusive)
querystringExtra Zendesk search filter applied to every count

Example request

curl https://app.plugsight.app/v1/tools/zendesk_ticket_stats \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-11-01","to":"2026-11-15"}'
zendesk_list_macrosReadList Zendesk macros

The saved replies and actions (macros) this agent can use, optionally filtered by words in the title. Use zendesk_apply_macro to use one.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
searchstringWords in the macro title

Example request

curl https://app.plugsight.app/v1/tools/zendesk_list_macros \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
zendesk_apply_macroChangeApply a Zendesk macro

Applies a macro to a ticket (its reply text, status, tags and other changes). Needs changes allowed for this Zendesk account and MCP server.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
ticket_id requiredintegerTicket number
macro_id requiredintegerMacro id from zendesk_list_macros
previewbooleantrue = only show what would change Default true.
confirmbooleanMust be true to apply: the user approved the previewed changes Default false.

Example request

curl https://app.plugsight.app/v1/tools/zendesk_apply_macro \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_id":1,"macro_id":1,"confirm":true}'
zendesk_create_ticketChangeCreate a Zendesk ticket

Opens a new ticket for a customer (by email; Zendesk creates the person if new), with a first message, priority, type and tags. By default the first message is an internal note, so the customer isn't emailed; set notify_requester: true to email them. Needs changes allowed for this Zendesk account and MCP server.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
accountstringZendesk account id from list_accounts (optional when there's only one)
subject requiredstringSubject
body requiredstringThe first message
requester_email requiredstringRequester's email address
requester_namestringRequester's name
notify_requesterbooleantrue = the first message is a public reply emailed to the requester Default false.
prioritystringPriority One of: low, normal, high, urgent.
typestringType One of: question, incident, problem, task.
tagsarray of stringTags
assignee_idintegerAgent user id (zendesk_find_users)
confirm requiredbooleanMust be true: the user approved these exact details

Example request

curl https://app.plugsight.app/v1/tools/zendesk_create_ticket \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"…","body":"…","requester_email":"someone@example.com","confirm":true}'

Marketing and analytics 12 tools

Needs: Google Search Console, Google Analytics, Google Ads or Microsoft Advertising (Pro and Agency)

list_marketing_accountsReadList marketing accounts

Lists the marketing connections this MCP can use and everything they reach: Search Console sites, Google Analytics 4 properties, Google Ads customers (including accounts under a manager/MCC) and Microsoft Advertising (Bing Ads) accounts. Use the returned ids in the other marketing tools. Call this first.

ArgumentTypeWhat it is
servicestringOnly this service One of: google_ads, microsoft_ads, search_console, analytics.
searchstringOnly resources whose name or id contains this text
refreshbooleanRe-discover now instead of using the 15-minute cache Default false.

Example request

curl https://app.plugsight.app/v1/tools/list_marketing_accounts \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
list_marketing_fieldsReadList marketing data fields

Every field get_marketing_data accepts for a connector, as dimensions and metrics with descriptions. Derived metrics (ctr, cpc, cpa, roas, conversion_rate…) are recalculated after combining rows, so they stay correct across accounts.

ArgumentTypeWhat it is
connector requiredstringgoogle_ads, microsoft_ads (Microsoft Advertising / Bing Ads), search_console, analytics (GA4) One of: google_ads, microsoft_ads, search_console, analytics.
searchstringOnly fields whose name or description contains this

Example request

curl https://app.plugsight.app/v1/tools/list_marketing_fields \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connector":"google_ads"}'
get_marketing_dataReadGet marketing data

The main analysis tool. Pulls any combination of dimensions and metrics from Google Ads, Microsoft Advertising, Search Console or GA4, for one, several or all connected accounts at once, and returns a compact table with totals. Pick fields from list_marketing_fields. The right report is chosen automatically (e.g. search_term → search-term report, keyword → keyword report). Examples: converting keywords: fields [keyword, match_type, campaign, cost, conversions, cpa, conversion_value, roas] with filter conversions gt 0; wasted spend: [search_term, keyword, cost, clicks, conversions] with conversions eq 0 and cost gt 20; SEO: [query, page, clicks, impressions, ctr, position]. Rows from different accounts are combined unless account_name is a field. Totals use the platform's own figures where it gives them (Search Console, GA4), so they can exceed the sum of rows. data_notes explain any data Google/Microsoft withhold; account_errors lists accounts that couldn't be read.

ArgumentTypeWhat it is
connector requiredstringgoogle_ads, microsoft_ads (Microsoft Advertising / Bing Ads), search_console, analytics (GA4) One of: google_ads, microsoft_ads, search_console, analytics.
fields requiredarray of stringDimensions and metrics, in output column order
accountsarray of stringAccount / customer / property ids or site URLs from list_marketing_accounts. Omit for all
date_presetstringUsed when date_from/date_to aren't given. Default last_30d One of: today, yesterday, last_7d, last_14d, last_28d, last_30d, last_90d, last_180d, last_365d, this_month, last_month, this_year, last_year.
date_fromstringYYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo")
date_tostringYYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo")
filtersarray of objectAll combine with AND. Text matching ignores case. Metric filters apply after combining rows Default [].
order_byarray of objectDefault: first metric, descending
limitintegerRows returned (after sorting) Default 500.
max_rows_per_accountintegerRows fetched per account before combining Default 100000.
totalsbooleanAdd a totals row Default true.
optionsobjectAdvanced report options Default {}.

Example request

curl https://app.plugsight.app/v1/tools/get_marketing_data \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connector":"google_ads","fields":[]}'
marketing_deep_diveReadMarketing deep dive

Ready-made analyses that combine several queries and return findings plus tables: - account_overview: every connected platform/account, this period vs previous (spend, conversions, CPA, ROAS, organic clicks, sessions, revenue) - wasted_spend (google_ads/microsoft_ads): non-converting search terms and keywords, % of budget wasted, negative-keyword candidates - scale_opportunities (ads): campaigns/keywords at or below average CPA that lose impression share to budget or rank - search_term_winners (ads): converting search terms not yet added as keywords - quality_score_audit (ads): spend by quality score and which component drags low scores down - paid_vs_organic (ads + Search Console): paying where you rank top 3, paid winners with weak SEO, organic queries worth a paid test - seo_opportunities (Search Console): striking-distance queries, low-CTR snippets, pages losing clicks - period_comparison (any connector, needs fields): this period vs previous period or last year, biggest gains and drops Use get_marketing_data to drill into anything a deep dive surfaces.

ArgumentTypeWhat it is
report requiredstringWhich ready-made analysis to run One of: account_overview, wasted_spend, scale_opportunities, search_term_winners, quality_score_audit, paid_vs_organic, seo_opportunities, period_comparison.
connectorstringAds reports: google_ads (default) or microsoft_ads. period_comparison: any One of: google_ads, microsoft_ads, search_console, analytics.
accountsarray of stringAccount ids for the connector. Omit for all
site_urlsarray of stringSearch Console sites for paid_vs_organic / seo_opportunities. Omit for all
date_presetstringDefault last_30d One of: last_7d, last_14d, last_28d, last_30d, last_90d, last_180d, last_365d, this_month, last_month, this_year, last_year.
date_fromstringYYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo")
date_tostringYYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo")
comparestringPeriod to compare with One of: previous_period, previous_year. Default "previous_period".
fieldsarray of stringperiod_comparison: dimensions + metrics, e.g. [campaign, cost, conversions, cpa]
filtersarray of objectperiod_comparison only
min_costnumberSpend threshold for wasted_spend lists Default 10.
min_conversionsnumberConversion threshold for winners / scale reports Default 1.
min_impressionsnumberImpression threshold for SEO reports Default 100.
topintegerRows per table Default 25.

Example request

curl https://app.plugsight.app/v1/tools/marketing_deep_dive \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"report":"account_overview"}'
search_console_inspect_urlReadInspect URL in Search Console

Index status of one URL as Google sees it: coverage, last crawl, canonical, mobile usability, rich results.

ArgumentTypeWhat it is
site_url requiredstringSite from list_marketing_accounts that contains the URL
url requiredstringFull URL to inspect
language_codestringFor translated issue messages, e.g. en-GB
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/search_console_inspect_url \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"site_url":"…","url":"…"}'
search_console_sitemapsReadList sitemaps

Sitemaps submitted for a Search Console site, with submitted/indexed counts, errors and warnings.

ArgumentTypeWhat it is
site_url requiredstringSearch Console site from list_marketing_accounts (optional with one site)
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/search_console_sitemaps \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"site_url":"…"}'
analytics_realtimeReadGoogle Analytics 4 realtime

Activity in the last 30 minutes, e.g. activeUsers by country, unifiedScreenName or eventName (GA4 API names).

ArgumentTypeWhat it is
property_id requiredstringGA4 property id from list_marketing_accounts (optional with one property)
metricsarray of stringGA4 realtime metrics Default ["activeUsers"].
dimensionsarray of stringGA4 realtime dimensions Default [].
limitintegerMost results to return Default 50.
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/analytics_realtime \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"property_id":"…"}'
analytics_key_eventsReadGA4 key events

The events a GA4 property counts as key events (conversions), with how many happened and the key event rate in a period. Use it to answer 'what counts as a conversion here' and 'which conversions are happening'. For breakdowns by channel or page, use get_marketing_data with conversions.

ArgumentTypeWhat it is
property_id requiredstringGA4 property id from list_marketing_accounts (optional with one property)
start_datestringYYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "28daysAgo".
end_datestringYYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "yesterday".
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/analytics_key_events \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"property_id":"…"}'
analytics_funnelReadGA4 funnel

Builds a funnel from 2–10 steps and shows how many users reach each step, the completion rate and where they drop off. Each step is an event (e.g. view_item, add_to_cart, begin_checkout, purchase) or a page (page view whose URL contains text). Closed funnels (default) count users who start at step 1; open funnels let users enter at any step. Optionally break down by a dimension such as deviceCategory or sessionDefaultChannelGroup.

ArgumentTypeWhat it is
property_id requiredstringGA4 property id from list_marketing_accounts (optional with one property)
steps requiredarray of objectFunnel steps, in order: each a name and an event
open_funnelbooleantrue: people can enter at any step Default false.
breakdownstringGA4 dimension, e.g. deviceCategory
start_datestringYYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "28daysAgo".
end_datestringYYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "yesterday".
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/analytics_funnel \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"property_id":"…","steps":[]}'
analytics_metadataReadGA4 dimensions and metrics

All dimensions and metrics available for a GA4 property, including its custom definitions. Any of these work in get_marketing_data.

ArgumentTypeWhat it is
property_id requiredstringGA4 property id from list_marketing_accounts (optional with one property)
searchstringOnly fields whose name or description contains this
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/analytics_metadata \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"property_id":"…"}'
google_ads_queryReadGoogle Ads query (GAQL)

Runs any read-only Google Ads Query Language SELECT against one customer, for anything get_marketing_data doesn't cover. Rows come back flattened ("campaign.name", "metrics.clicks"). cost_micros ÷ 1,000,000 = account currency. Manager accounts can't report metrics; query their clients.

ArgumentTypeWhat it is
customer_id requiredstringCustomer id from list_marketing_accounts (dashes optional)
query requiredstringGAQL SELECT statement
limitintegerMost results to return Default 500.
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/google_ads_query \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"…","query":"…"}'
microsoft_ads_campaignsReadMicrosoft Advertising campaigns

Campaign settings in a Microsoft Advertising account: status, type, budget and bidding strategy.

ArgumentTypeWhat it is
account_id requiredstringAccount id from list_marketing_accounts (optional with one account)
connectionstringConnection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically.

Example request

curl https://app.plugsight.app/v1/tools/microsoft_ads_campaigns \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"…"}'

Calendar 7 tools

Needs: Google, Outlook or iCloud Calendar

calendar_list_calendarsReadList calendars

Calendars this connection can read (Google, Outlook or iCloud), with their ids, time zones and whether events can be added.

ArgumentTypeWhat it is
accountstringConnection id from list_accounts (optional when there's only one of this type)

Example request

curl https://app.plugsight.app/v1/tools/calendar_list_calendars \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
calendar_list_eventsReadList calendar events

Events between two times, across all visible calendars or one, optionally matching text. Times are ISO 8601 (e.g. "2026-11-20T09:00:00+04:00") or dates (YYYY-MM-DD), which cover whole days in the calendar's time zone. Recurring events are expanded. Long descriptions are shortened (description_truncated: true); calendar_get_event returns an event in full. When more events match than limit, the result says truncated: true and gives next_from to continue from.

ArgumentTypeWhat it is
from requiredstringStart: ISO date-time or YYYY-MM-DD
to requiredstringEnd: ISO date-time or YYYY-MM-DD (inclusive for dates)
querystringText to match in title, description, location or attendees
calendar_idstringOne calendar id from calendar_list_calendars; default all visible
time_zonestringIANA time zone for dates and times given without an offset, e.g. "Europe/London". Default: the calendar's own
limitintegerMost events to return Default 100.
accountstringConnection id from list_accounts (optional when there's only one of this type)

Example request

curl https://app.plugsight.app/v1/tools/calendar_list_events \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-11-01","to":"2026-11-15"}'
calendar_get_eventReadRead a calendar event

One event in full: the whole description, every guest and their reply, video-call and dial-in links, location and attached files (names and links). Use an event id (and calendar_id) from calendar_list_events.

ArgumentTypeWhat it is
event_id requiredstringEvent id from calendar_list_events
calendar_idstringThe event's calendar_id from calendar_list_events; default: look in each visible calendar
accountstringConnection id from list_accounts (optional when there's only one of this type)

Example request

curl https://app.plugsight.app/v1/tools/calendar_get_event \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"…"}'
calendar_find_free_timeReadFind free time

Busy times across visible calendars between two times, and free gaps of at least min_minutes. Dates (YYYY-MM-DD) cover whole days in the calendar's time zone. Events marked free don't block time; all-day events marked busy or out of office do. Use it to suggest meeting slots; check notes for calendars that couldn't be read.

ArgumentTypeWhat it is
from requiredstringStart: ISO date-time or YYYY-MM-DD
to requiredstringEnd: ISO date-time or YYYY-MM-DD (inclusive for dates)
time_zonestringIANA time zone for dates and times given without an offset, e.g. "Europe/London". Default: the calendar's own
min_minutesintegerShortest free gap worth listing, in minutes Default 30.
accountstringConnection id from list_accounts (optional when there's only one of this type)

Example request

curl https://app.plugsight.app/v1/tools/calendar_find_free_time \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-11-01","to":"2026-11-15"}'
calendar_create_eventChangeBook a calendar event

Creates an event, optionally inviting guests (and, on Google calendars, adding a Google Meet link). Check calendar_find_free_time first. Times are ISO 8601 with offset (e.g. "2026-11-20T15:00:00+04:00"), or YYYY-MM-DD for all-day events (end is the day after).

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
title requiredstringEvent title
start requiredstringISO date-time with offset, or YYYY-MM-DD for all day
end requiredstringISO date-time with offset, or YYYY-MM-DD (exclusive) for all day
time_zonestringIANA zone, e.g. "Europe/London"; default the calendar's
descriptionstringDescription
locationstringLocation
guestsarray of stringEmail addresses to invite
google_meetbooleanAdd a Google Meet video link (Google calendars only) Default false.
notify_guestsbooleanEmail the guests (invitations, updates or cancellation) Default true.
calendar_idstringDefault: the primary calendar
accountstringConnection id from list_accounts (optional when there's only one of this type)
confirm requiredbooleanMust be true: the user approved these exact details

Example request

curl https://app.plugsight.app/v1/tools/calendar_create_event \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","start":"2026-11-20T15:00:00+00:00","end":"2026-11-20T15:30:00+00:00","confirm":true}'
calendar_update_eventChangeChange a calendar event

Moves or edits an event: new time, title, description, location, or more guests. Only the fields given change. Use the event id from calendar_list_events.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
event_id requiredstringEvent id from calendar_list_events
calendar_idstringThe event's calendar; default the primary calendar
titlestringNew title
startstringNew start, ISO 8601 date-time
endstringNew end, ISO 8601 date-time
time_zonestringIANA time zone, e.g. Europe/London
descriptionstringDescription
locationstringLocation
add_guestsarray of stringGuest email addresses to invite
notify_guestsbooleanEmail the guests (invitations, updates or cancellation) Default true.
accountstringConnection id from list_accounts (optional when there's only one of this type)
confirm requiredbooleanMust be true: the user approved these exact details

Example request

curl https://app.plugsight.app/v1/tools/calendar_update_event \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"…","confirm":true}'
calendar_cancel_eventChangeCancel a calendar event

Deletes an event and, by default, emails guests a cancellation. For a repeating event, Google cancels only the given occurrence; iCloud cancels the whole series.

Makes a change, so it needs "confirm": true and changes allowed. How changes work.

ArgumentTypeWhat it is
event_id requiredstringEvent id from calendar_list_events
calendar_idstringCalendar id from calendar_list_calendars (default: the main calendar)
notify_guestsbooleanEmail the guests (invitations, updates or cancellation) Default true.
accountstringConnection id from list_accounts (optional when there's only one of this type)
confirm requiredbooleanMust be true: the user approved these exact details

Example request

curl https://app.plugsight.app/v1/tools/calendar_cancel_event \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"…","confirm":true}'

Contacts 3 tools

Needs: Google, Outlook or iCloud Contacts

contacts_listReadList contacts

Saved contacts with paging (Google: most recently changed first; iCloud and Outlook: by name). A note means the list isn't complete, and says why.

ArgumentTypeWhat it is
limitintegerMost results to return Default 100.
page_tokenstringnext_page_token from the previous page
accountstringConnection id from list_accounts (optional when there's only one of this type)

Example request

curl https://app.plugsight.app/v1/tools/contacts_list \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
contacts_getReadGet a contact

Everything saved for one contact: emails, phones, organisation, addresses, notes, birthday and links.

ArgumentTypeWhat it is
id requiredstringContact id from contacts_search or contacts_list
accountstringConnection id from list_accounts (optional when there's only one of this type)

Example request

curl https://app.plugsight.app/v1/tools/contacts_get \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"…"}'

WooCommerce 5 tools

Needs: A WooCommerce store

woocommerce_sales_reportReadWooCommerce sales

Sales for a period from a WooCommerce store: gross and net sales, orders, items sold, average order, tax, shipping, refunds and discounts, with a per-day (or per-month) breakdown and the best-selling products with quantity and net revenue. Use it for 'how did the shop do' questions.

ArgumentTypeWhat it is
from requiredstringYYYY-MM-DD
to requiredstringYYYY-MM-DD
top_productsintegerHow many best-selling products to list Default 10.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/woocommerce_sales_report \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-11-01","to":"2026-11-15"}'
woocommerce_list_ordersReadList WooCommerce orders

Orders, newest first, optionally by status, date range or a search (customer name, email, order number or product). Use woocommerce_get_order for the items, addresses and notes of one order.

ArgumentTypeWhat it is
statusstringStatus One of: any, pending, processing, on-hold, completed, cancelled, refunded, failed, checkout-draft. Default "any".
fromstringYYYY-MM-DD
tostringYYYY-MM-DD
searchstringSearch text
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/woocommerce_list_orders \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
woocommerce_get_orderReadRead a WooCommerce order

One order in full: items with the options chosen (size, colour, add-ons) and variation id, totals, fees, discounts, shipping, refunds, payment method and transaction id, when it was paid and completed, shipment tracking, customer, addresses and order notes.

ArgumentTypeWhat it is
order_id requiredintegerOrder number
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/woocommerce_get_order \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"order_id":1}'
woocommerce_search_productsReadSearch WooCommerce products

Products by name or SKU, optionally only those out of stock or on backorder, with price, stock level and total sales. Sort by popularity to see best sellers of all time. Set include_variations to list each variable product's variations (size, colour…) with their own SKU, price and stock, which the product itself doesn't show.

ArgumentTypeWhat it is
searchstringSearch text
skustringProduct SKU
stock_statusstringOnly products with this stock status One of: instock, outofstock, onbackorder.
orderbystringSort products by One of: popularity, date, title, price, rating. Default "popularity".
include_variationsbooleanAlso list each variable product's variations with SKU, price and stock Default false.
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/woocommerce_search_products \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
woocommerce_search_customersReadSearch WooCommerce customers

Registered customers by name or email, with how many orders they placed and how much they spent. Newest first unless searching. Guest checkouts aren't customers here; find them with woocommerce_list_orders.

ArgumentTypeWhat it is
searchstringName or email
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/woocommerce_search_customers \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Magento / Adobe Commerce 5 tools

Needs: A Magento store

magento_sales_reportReadMagento sales

Sales for a period from a Magento / Adobe Commerce store, added up from every order in it: revenue, orders, items, average order, discounts, shipping, tax and refunds, a per-day breakdown and the best-selling products. Only paid orders count (processing, complete, closed); unpaid, on-hold, in-review and cancelled orders are listed separately under excluded. Totals are per currency when the store has several. On very busy stores the report can stop early: then complete is false and covered_through says how far it got. Dates are UTC.

ArgumentTypeWhat it is
from requiredstringYYYY-MM-DD (UTC)
to requiredstringYYYY-MM-DD (UTC)
top_productsintegerHow many best-selling products to list Default 10.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/magento_sales_report \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-11-01","to":"2026-11-15"}'
magento_list_ordersReadList Magento orders

Orders, newest first, optionally by status, date range (UTC) or customer email. Use magento_get_order for the items, addresses, payment and comments of one order.

ArgumentTypeWhat it is
statusstringe.g. pending, processing, complete, canceled, closed, holded
fromstringYYYY-MM-DD (UTC)
tostringYYYY-MM-DD (UTC)
emailstringCustomer email, or part of it
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/magento_list_orders \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
magento_get_orderReadRead a Magento order

One order in full by its order number (e.g. 000000123) or id: items with the variant and options chosen, quantities shipped and refunded, totals, discounts, shipping, refunds, payment method, addresses, comments, and its shipments (with tracking numbers), invoices and credit memos.

ArgumentTypeWhat it is
order requiredstringOrder number as customers see it, or the id from magento_list_orders
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/magento_get_order \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"order":"…"}'
magento_search_productsReadSearch Magento products

Products by name or SKU with price, special (sale) price, stock quantity, type and status. Set low_stock_below to list products whose stock is at or under that quantity instead, with their SKU and name.

ArgumentTypeWhat it is
searchstringPart of the product name
skustringSKU, or part of it
low_stock_belowintegerOnly products with less stock than this
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/magento_search_products \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
magento_search_customersReadSearch Magento customers

Registered customers by email or name, with when they joined and their default address. Use magento_list_orders with email for their orders.

ArgumentTypeWhat it is
emailstringEmail, or part of it
namestringFirst or last name, or part of it
limitintegerMost results to return Default 25.
pageintegerPage of results, from 1 Default 1.
accountstringStore connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/magento_search_customers \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Mailchimp 7 tools

Needs: A Mailchimp account

mailchimp_list_audiencesReadList Mailchimp audiences

Audiences (lists) with subscribers, unsubscribes, cleaned addresses, average open and click rates and how many campaigns each has had. Use the ids in the other Mailchimp tools.

ArgumentTypeWhat it is
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_list_audiences \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
mailchimp_list_campaignsReadList Mailchimp campaigns

Campaigns, newest first, with subject, audience, emails sent, open and click rates, and orders and revenue when the store is connected to Mailchimp. Filter by status, send date or audience. Use mailchimp_campaign_report for one campaign in full.

ArgumentTypeWhat it is
statusstringsent (default), save (drafts), schedule, sending, paused One of: sent, save, schedule, sending, paused. Default "sent".
sent_fromstringYYYY-MM-DD
sent_tostringYYYY-MM-DD
audience_idstringAudience id from mailchimp_list_audiences
limitintegerMost results to return Default 25.
offsetintegerResults to skip, for paging Default 0.
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_list_campaigns \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
mailchimp_campaign_reportReadMailchimp campaign report

One sent campaign's full results: opens, clicks, bounces, unsubscribes, spam complaints, orders and revenue, how it compares with the audience's average and the industry, and its most-clicked links. For an A/B test, what was tested, each variation's results and the winner.

ArgumentTypeWhat it is
campaign_id requiredstringCampaign id from mailchimp_list_campaigns
top_linksintegerHow many most-clicked links to list Default 10.
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_campaign_report \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaign_id":"…"}'
mailchimp_audience_growthReadMailchimp audience growth

Month-by-month growth of one audience: new subscribers (opt-ins and imports), unsubscribes, cleaned addresses and the total at month end.

ArgumentTypeWhat it is
audience_id requiredstringAudience id from mailchimp_list_audiences
monthsintegerHow many months back Default 12.
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_audience_growth \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"audience_id":"…"}'
mailchimp_find_subscriberReadFind a Mailchimp subscriber

Looks someone up by email address or name across audiences: their status (subscribed, unsubscribed, cleaned), when they joined, tags, rating, average open and click rates, their audience fields (merge fields such as name, birthday, address) and the groups (interests) they're in.

ArgumentTypeWhat it is
query requiredstringEmail address, or part of a name or email
audience_idstringOnly this audience
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_find_subscriber \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"…"}'
mailchimp_list_automationsReadList Mailchimp automations

Classic automations (welcome series, abandoned cart, date-based…) with their status, audience, trigger, emails sent and open and click rates; with include_emails, each email in the series with its delay and results. Mailchimp's API doesn't list Customer Journeys (the newer journey builder), so those aren't included.

ArgumentTypeWhat it is
include_emailsbooleanAlso list each automation's emails with their delay and results Default false.
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_list_automations \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
mailchimp_list_segmentsReadList Mailchimp tags and segments

An audience's tags and saved segments with how many contacts each has. Use the audience id from mailchimp_list_audiences.

ArgumentTypeWhat it is
audience_id requiredstringAudience id from mailchimp_list_audiences
accountstringMailchimp connection id from list_accounts (optional when there's only one)

Example request

curl https://app.plugsight.app/v1/tools/mailchimp_list_segments \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"audience_id":"…"}'

PageSpeed and Core Web Vitals 1 tool

Needs: Nothing to connect: every MCP server has it

pagespeed_checkReadCheck page speed and Core Web Vitals

Google PageSpeed Insights for any public page: performance, SEO, accessibility and best-practice scores; real-user Core Web Vitals (LCP, INP, CLS) for the page and the whole site from Chrome users, as Google Search uses them; lab timings; and the fixes that would save the most time. Takes 10–40 seconds.

ArgumentTypeWhat it is
url requiredstringThe page to check, e.g. https://example.com/pricing
strategystringMobile is what Google ranks on One of: mobile, desktop. Default "mobile".
categoriesarray of stringWhich scores to include One of: performance, seo, accessibility, best-practices. Default ["performance","seo","accessibility","best-practices"].

Example request

curl https://app.plugsight.app/v1/tools/pagespeed_check \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"…"}'

Show data on your website

The key must stay secret, so your web page asks your own server, and your server asks Plugsight:

  1. Web pageCalls /api/stats on your own site.
  2. Your serverAdds the key, calls Plugsight, keeps only the numbers the page needs.
  3. PlugsightReads live from Google, Zendesk and so on.

For example, a small Node.js (Express) route that shows this month's open tickets and sessions, cached for 5 minutes:

import express from "express";

const app = express();
const KEY = process.env.PLUGSIGHT_API_KEY;
let cache = { at: 0, value: null };

async function plugsight(tool, args = {}) {
  const res = await fetch(`https://app.plugsight.app/v1/tools/${tool}`, {
    method: "POST",
    headers: { Authorization: `Bearer ${KEY}`, "Content-Type": "application/json" },
    body: JSON.stringify(args),
  });
  const body = await res.json();
  if (!res.ok) throw new Error(`${body.error}: ${body.message}`);
  return body.data;
}

app.get("/api/stats", async (req, res) => {
  if (Date.now() - cache.at > 5 * 60_000) {
    const [tickets, traffic] = await Promise.all([
      plugsight("zendesk_ticket_stats", { from: "2026-11-01", to: "2026-11-30" }),
      plugsight("get_marketing_data", { connector: "analytics", fields: ["sessions"], date_preset: "this_month" }),
    ]);
    cache = { at: Date.now(), value: { tickets, traffic } };
  }
  res.json(cache.value);
});

app.listen(3000);

Serverless works the same way (Vercel, Netlify, Cloudflare Workers): keep the key in the platform's environment variables.

Code examples

Python

import os, requests

def plugsight(tool, **args):
    r = requests.post(f"https://app.plugsight.app/v1/tools/{tool}",
        headers={"Authorization": f"Bearer {os.environ['PLUGSIGHT_API_KEY']}"},
        json=args, timeout=60)
    body = r.json()
    if not r.ok:
        raise RuntimeError(f"{body['error']}: {body['message']}")
    return body["data"]

print(plugsight("zendesk_ticket_stats", **{"from": "2026-11-01", "to": "2026-11-15"}))
print(plugsight("woocommerce_sales_report", **{"from": "2026-11-08", "to": "2026-11-15"}))

PHP

<?php
function plugsight(string $tool, array $args = []) {
    $ch = curl_init("https://app.plugsight.app/v1/tools/$tool");
    curl_setopt_array($ch, [
        CURLOPT_POST => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => [
            "Authorization: Bearer " . getenv("PLUGSIGHT_API_KEY"),
            "Content-Type: application/json",
        ],
        CURLOPT_POSTFIELDS => json_encode($args ?: new stdClass()),
    ]);
    $body = json_decode(curl_exec($ch), true);
    if (curl_getinfo($ch, CURLINFO_HTTP_CODE) !== 200) throw new Exception($body["message"]);
    return $body["data"];
}

$accounts = plugsight("list_accounts");

Google Sheets (Apps Script)

function plugsight(tool, args) {
  const key = PropertiesService.getScriptProperties().getProperty("PLUGSIGHT_API_KEY");
  const res = UrlFetchApp.fetch("https://app.plugsight.app/v1/tools/" + tool, {
    method: "post",
    contentType: "application/json",
    headers: { Authorization: "Bearer " + key },
    payload: JSON.stringify(args || {}),
  });
  return JSON.parse(res.getContentText()).data;
}

Questions

Do I need to know what MCP is?

No. "MCP server" is just what the app calls a project with a key, because AI apps use the same projects. For the API it's a key that reaches the accounts you picked.

Which plans include the API?

Pro and Agency. See Pricing.

What can I pull?

Whatever the project's connections reach: Google Ads, Microsoft Advertising, Google Search Console, Google Analytics 4, WooCommerce, Magento / Adobe Commerce, Mailchimp, Gmail, Outlook & Microsoft 365, iCloud Mail, Any email (IMAP), Zendesk, Google Calendar, Outlook Calendar, Outlook Contacts, iCloud Calendar, iCloud Contacts and Google Contacts. See the tool reference and every connector.

Can I call it from a web page or mobile app?

Not directly: the key would be visible to anyone. Call it from your server or a serverless function, and send your page only the numbers it needs. See how.

Is the data cached or stored?

No. Each call reads live from the source. Cache results on your side if you show them often; it's faster and keeps you under the limits.

Why did a tool disappear?

Tools follow the project's connections. If you remove Zendesk from the project, or its connection needs signing in again, its tools go away until it's back. list_accounts shows each account's state.

Is it the same as the AI app connection?

Yes: same projects, same tools, same permissions and the same Activity log. AI apps sign in or use the key through MCP; your code uses the key through this JSON API.

Where do I get help?

Email support from the app's Help page, with the error and message you got and the time of the request.

Build on your own data

Connect your accounts once; use them from your AI and your own code.

Updated