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.
- Connect your accountsSign in to Google Ads, Zendesk, your mailbox and so on, once, in the Plugsight app.
- Choose what the key can reachGroup the accounts into a project and create its API key.
- 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.
- Connect an account. Open Connections in the app and connect what you want data from, for example Google Analytics.
- 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.
- 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_…" - 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": {} } }, … ] } - 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)" } ] } - 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 URL | https://app.plugsight.app/v1 (HTTPS only) |
|---|---|
| Run a tool | POST /v1/tools/<tool name>. The JSON body is the tool's arguments. Send {} when it takes none. |
| Headers | Authorization: Bearer <key> and Content-Type: application/json |
| Success | Status 200 with { "data": … }. What's inside data depends on the tool: usually an object or a list. |
| Failure | Status 4xx/5xx with { "error", "message", "docs" }. See Errors. |
| Dates | YYYY-MM-DD; date-times in ISO 8601 with an offset, e.g. 2026-11-20T15:00:00+00:00. |
| Paging | Tools with many results take limit and page, offset or page_token; each tool's arguments say which. |
| Freshness | Live: 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:
- 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. - The project allows changes: Allow changes is ticked on its page.
- 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"
}| Status | error | What happened | What to do |
|---|---|---|---|
| 400 | tool_error | The 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. |
| 401 | unauthorized | The key is missing, mistyped, regenerated or revoked. | Check the header, or create a new key. |
| 403 | plan_required | The account isn't on Pro or Agency. | Upgrade under Billing in the app. |
| 404 | unknown_tool | The 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. |
| 404 | not_found | The address isn't an API endpoint. | Use one of the endpoints. |
| 429 | rate_limited | Over 120 requests in a minute for this project. | Wait the Retry-After seconds, then retry. |
| 500 | server_error | Something 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_errorexplaining 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, Meta Ads, LinkedIn Ads, TikTok Ads, Tag Manager, YouTube and Merchant Center; Google Drive and Sheets; Google, iCloud or Outlook Calendar and Contacts; WooCommerce, Magento and Shopify stores; Mailchimp; Bing Webmaster Tools; Custom APIs; custom MCP servers), 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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Account id, or "all" (default) |
folder | string | Folder path from list_folders, or: inbox (default), sent, drafts, trash, junk, archive, all (every folder except trash/junk) |
query | string | Free text anywhere in the email |
from | string or array of string | Sender name/address contains (string or list, any match) |
to | string or array of string | Recipient (To) contains |
cc | string or array of string | Cc contains |
bcc | string or array of string | Bcc contains (only visible on emails you sent) |
subject | string | Subject contains |
body | string | Body contains |
exclude_from | string or array of string | Leave out emails from these senders |
exclude_subject | string | Leave out emails whose subject contains this |
exclude_text | string | Leave out emails containing this text |
since | string | On or after this date, YYYY-MM-DD |
before | string | Before this date, YYYY-MM-DD |
unread | boolean | true = only unread, false = only read |
flagged | boolean | true = only flagged/starred, false = only unflagged |
answered | boolean | true = only emails you replied to, false = not replied |
has_attachment | boolean | true = has real attachments (images embedded in the body don't count), false = none |
attachment_name | string | An attachment's filename contains this |
attachment_type | string | Has an attachment of this type: pdf, image, document, spreadsheet, presentation, calendar, archive, email, audio, video, or a file extension |
larger_than_kb | number | Email size above this many KB |
smaller_than_kb | number | Email size below this many KB |
sort | string | Sort order One of: newest, oldest. Default "newest". |
include_preview | boolean | Include a ~200 character body preview Default true. |
limit | integer | Most results to return Default 20. |
offset | integer | Skip this many results (pagination) Default 0. |
cursor | string | next_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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id from list_accounts |
email_id required | string | Email id from search_emails |
include_html | boolean | Also return the raw HTML body Default false. |
include_headers | boolean | Also return all raw headers (e.g. List-Unsubscribe, Received, authentication results) Default false. |
max_chars | integer | Truncate 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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id from list_accounts |
email_id required | string | Email id from search_emails |
max_chars_per_email | integer | Longest 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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id from list_accounts |
email_id required | string | Email id from search_emails |
attachment required | integer or string | Index from get_email (e.g. 0), or a nested path (e.g. "2.0") |
mode | string | auto: text when the file can be read as text; base64: the raw file One of: auto, base64. Default "auto". |
max_chars | integer | Truncate 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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id to send from (list_accounts) |
to | string or array of string | Recipients: address or "Name <address>" (string or list) |
cc | string or array of string | Cc recipients: address or list |
bcc | string or array of string | Bcc recipients: address or list |
subject | string | Subject. Defaults to "Re: …" / "Fwd: …" for replies and forwards |
body required | string | Plain-text body. For replies/forwards the original is quoted below it automatically |
reply_to_email_id | string | Reply to this email (sender is added as recipient, threading kept) |
reply_all | boolean | With reply_to_email_id: also include the original To and Cc Default false. |
forward_email_id | string | Forward this email, including its attachments |
attachments | array of object | Files 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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id to send from (list_accounts) |
to | string or array of string | Recipients: address or "Name <address>" (string or list) |
cc | string or array of string | Cc recipients: address or list |
bcc | string or array of string | Bcc recipients: address or list |
subject | string | Subject. Defaults to "Re: …" / "Fwd: …" for replies and forwards |
body required | string | Plain-text body. For replies/forwards the original is quoted below it automatically |
reply_to_email_id | string | Reply to this email (sender is added as recipient, threading kept) |
reply_all | boolean | With reply_to_email_id: also include the original To and Cc Default false. |
forward_email_id | string | Forward this email, including its attachments |
attachments | array of object | Files to attach: email_id + attachment index from an email, or name + base64 content |
confirm required | boolean | Must 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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id from list_accounts |
email_ids required | array of string | Email ids from search_emails or get_thread |
read | boolean | true = mark read, false = mark unread |
flagged | boolean | true = flag/star, false = remove the flag |
add_labels | array of string | Gmail labels or Outlook categories to add (created if new) |
remove_labels | array of string | Labels or folders to remove |
move_to | string | "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.
| Argument | Type | What it is |
|---|---|---|
account required | string | Account id from list_accounts |
draft_id required | string | Email id of the draft |
confirm required | boolean | Must 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 13 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", "updated>24hours", or plain words. Newest updated first. status takes new, open, pending, hold, solved or closed; a custom status (e.g. "Waiting on customer") is custom_status_id:<id> from zendesk_list_ticket_statuses (a custom status name after status: is translated for you). Dates are yyyy-mm-dd, an ISO time with offset, or relative such as updated>24hours (7d, today and yesterday are translated). 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
query | string | Zendesk search query (type:ticket is added automatically) |
sort_by | string | Field to sort by One of: updated_at, created_at, priority, status. Default "updated_at". |
sort_order | string | asc or desc One of: desc, asc. Default "desc". |
limit | integer | Most results to return Default 25. |
page | integer | Page 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), its custom status when the account has them (custom_status, e.g. "Waiting on customer"; status is its category) and the full conversation (public replies and internal notes, oldest first). For email, source shows which address wrote and which support address received it; replies_from is the support address public replies go out from. 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
ticket_id required | integer | Ticket number |
include_comments | boolean | Include the ticket's comments Default true. |
max_chars_per_comment | integer | Longest 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
ticket_id required | integer | Ticket number |
comment_id required | integer | Comment id from zendesk_get_ticket |
attachment required | integer or string | File index from zendesk_get_ticket (e.g. 0), or a path inside an attached email (e.g. "1.0") |
mode | string | auto: text when the file can be read as text; base64: the raw file One of: auto, base64. Default "auto". |
max_chars | integer | Truncate 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_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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
query required | string | Search 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_list_support_addressesReadList Zendesk support addresses
The email addresses customers write to in this Zendesk account, each with its brand and whether it's the default. A ticket's replies go out from one of these; choose a different one with from_address on zendesk_create_ticket or zendesk_update_ticket.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
Example request
curl https://app.plugsight.app/v1/tools/zendesk_list_support_addresses \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'zendesk_list_ticket_statusesReadList Zendesk ticket statuses
The ticket statuses agents can choose in this Zendesk account, including custom ones such as "Waiting on customer" or "In progress", each with its id, its category (new, open, pending, hold or solved) and whether it's that category's default. Set one with custom_status on zendesk_update_ticket or zendesk_add_comment. Accounts without custom ticket statuses only have the built-in statuses (available: false); use status for those.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
Example request
curl https://app.plugsight.app/v1/tools/zendesk_list_ticket_statuses \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
ticket_id required | integer | Ticket number |
max_chars_per_message | integer | Longest 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 (status, or custom_status for one of the account's own statuses such as "Waiting on customer"). 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
ticket_id required | integer | Ticket number |
body required | string | Text of the reply or note |
public required | boolean | true = public reply to the customer, false = internal note |
status | string | Also set the ticket status One of: open, pending, hold, solved. |
custom_status | string or integer | One of the account's ticket statuses (zendesk_list_ticket_statuses), by its name (any case, e.g. "Waiting on customer") or id. It also sets the ticket's status to that status's category, so don't pass status as well. |
confirm required | boolean | Must 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, tags or the support address its replies go out from (from_address, which also moves it to that address's brand). For one of the account's own statuses, such as "Waiting on customer", use custom_status instead of status (zendesk_list_ticket_statuses). Needs changes allowed for this Zendesk account and MCP server.
Makes a change, so it needs "confirm": true and changes allowed. How changes work.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
ticket_id required | integer | Ticket number |
status | string | Status One of: new, open, pending, hold, solved, closed. |
custom_status | string or integer | One of the account's ticket statuses (zendesk_list_ticket_statuses), by its name (any case, e.g. "Waiting on customer") or id. It also sets the ticket's status to that status's category, so don't pass status as well. |
priority | string | Priority One of: low, normal, high, urgent. |
type | string | Type One of: question, incident, problem, task. |
assignee_id | integer | Agent user id (zendesk_find_users) |
add_tags | array of string | Tags to add |
remove_tags | array of string | Tags to remove |
from_address | string | Support address the ticket's emails go out from, e.g. help@brand-b.com (zendesk_list_support_addresses). When the account has several and the user didn't say which, ask them. |
confirm required | boolean | Must 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
from required | string | Period start, YYYY-MM-DD |
to required | string | Period end, YYYY-MM-DD (inclusive) |
query | string | Extra 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
search | string | Words 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.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
ticket_id required | integer | Ticket number |
macro_id required | integer | Macro id from zendesk_list_macros |
preview | boolean | true = only show what would change Default true. |
confirm | boolean | Must 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. It goes out from the account's default support address unless from_address names another (that address's brand is used too). Needs changes allowed for this Zendesk account and MCP server.
Makes a change, so it needs "confirm": true and changes allowed. How changes work.
| Argument | Type | What it is |
|---|---|---|
account | string | Zendesk account id from list_accounts (optional when there's only one) |
subject required | string | Subject |
body required | string | The first message |
requester_email required | string | Requester's email address |
requester_name | string | Requester's name |
notify_requester | boolean | true = the first message is a public reply emailed to the requester Default false. |
priority | string | Priority One of: low, normal, high, urgent. |
type | string | Type One of: question, incident, problem, task. |
tags | array of string | Tags |
assignee_id | integer | Agent user id (zendesk_find_users) |
from_address | string | Support address the ticket's emails go out from, e.g. help@brand-b.com (zendesk_list_support_addresses). When the account has several and the user didn't say which, ask them. |
confirm required | boolean | Must 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 15 tools
Needs: Google Search Console, Google Analytics, Google Ads, Microsoft Advertising, Meta Ads, LinkedIn Ads or TikTok Ads (coming soon) (Pro and Agency; Free can try 1 connection and 25 calls a month)
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), Microsoft Advertising (Bing Ads) accounts, Meta (Facebook and Instagram) ad accounts, LinkedIn ad accounts and TikTok advertisers (ad accounts). Use the returned ids in the other marketing tools. Call this first.
| Argument | Type | What it is |
|---|---|---|
service | string | Only this service One of: google_ads, microsoft_ads, meta_ads, linkedin_ads, tiktok_ads, search_console, analytics. |
search | string | Only resources whose name or id contains this text |
refresh | boolean | Re-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.
| Argument | Type | What it is |
|---|---|---|
connector required | string | google_ads, microsoft_ads (Microsoft Advertising / Bing Ads), meta_ads (Facebook and Instagram ads), linkedin_ads, tiktok_ads, search_console, analytics (GA4) One of: google_ads, microsoft_ads, meta_ads, linkedin_ads, tiktok_ads, search_console, analytics. |
search | string | Only 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, Meta Ads, LinkedIn Ads, TikTok Ads, 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. Meta Ads: campaign → campaign level, ad_set / ad → finer levels; conversions are purchases unless options.conversion_action names another action. LinkedIn Ads: campaign_group, campaign and ad (creative) levels; conversions are website conversions and leads are Lead Gen Form leads. TikTok Ads: campaign / ad_group / ad set the level; conversions are TikTok's Conversions column and conversion_value is website purchase value; any TikTok report metric is tiktok:<metric> (rates such as tiktok:ctr are null where rows are combined; prefer the shared ratios). data_notes explain any data Google, Microsoft, Meta or TikTok withhold; partial is true when an account stopped at a row limit (partial_reason says what is incomplete); account_errors lists accounts that couldn't be read.
| Argument | Type | What it is |
|---|---|---|
connector required | string | google_ads, microsoft_ads (Microsoft Advertising / Bing Ads), meta_ads (Facebook and Instagram ads), linkedin_ads, tiktok_ads, search_console, analytics (GA4) One of: google_ads, microsoft_ads, meta_ads, linkedin_ads, tiktok_ads, search_console, analytics. |
fields required | array of string | Dimensions and metrics, in output column order |
accounts | array of string | Account / customer / property ids or site URLs from list_marketing_accounts. Omit for all |
date_preset | string | Used 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_from | string | YYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo") |
date_to | string | YYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo") |
filters | array of object | All combine with AND. Text matching ignores case. Metric filters apply after combining rows Default []. |
order_by | array of object | Default: first metric, descending |
limit | integer | Rows returned (after sorting) Default 500. |
max_rows_per_account | integer | Rows fetched per account before combining Default 100000. |
totals | boolean | Add a totals row Default true. |
options | object | Advanced 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 (Google Ads, Microsoft Advertising, Meta Ads, LinkedIn Ads, TikTok Ads, Search Console, GA4), 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.
| Argument | Type | What it is |
|---|---|---|
report required | string | Which 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. |
connector | string | Ads reports: google_ads (default) or microsoft_ads. period_comparison: any One of: google_ads, microsoft_ads, meta_ads, linkedin_ads, tiktok_ads, search_console, analytics. |
accounts | array of string | Account ids for the connector. Omit for all |
site_urls | array of string | Search Console sites for paid_vs_organic / seo_opportunities. Omit for all |
date_preset | string | Default 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_from | string | YYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo") |
date_to | string | YYYY-MM-DD, or "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo") |
compare | string | Period to compare with One of: previous_period, previous_year. Default "previous_period". |
fields | array of string | period_comparison: dimensions + metrics, e.g. [campaign, cost, conversions, cpa] |
filters | array of object | period_comparison only |
min_cost | number | Spend threshold for wasted_spend lists Default 10. |
min_conversions | number | Conversion threshold for winners / scale reports Default 1. |
min_impressions | number | Impression threshold for SEO reports Default 100. |
top | integer | Rows per table Default 25. |
conversion_action | string | Meta Ads only: the action type counted as conversions, e.g. lead or complete_registration. Default: purchases |
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.
| Argument | Type | What it is |
|---|---|---|
site_url required | string | Site from list_marketing_accounts that contains the URL |
url required | string | Full URL to inspect |
language_code | string | For translated issue messages, e.g. en-GB |
connection | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
site_url required | string | Search Console site from list_marketing_accounts (optional with one site) |
connection | string | Connection 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).
| Argument | Type | What it is |
|---|---|---|
property_id required | string | GA4 property id from list_marketing_accounts (optional with one property) |
metrics | array of string | GA4 realtime metrics Default ["activeUsers"]. |
dimensions | array of string | GA4 realtime dimensions Default []. |
limit | integer | Most results to return Default 50. |
connection | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
property_id required | string | GA4 property id from list_marketing_accounts (optional with one property) |
start_date | string | YYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "28daysAgo". |
end_date | string | YYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "yesterday". |
connection | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
property_id required | string | GA4 property id from list_marketing_accounts (optional with one property) |
steps required | array of object | Funnel steps, in order: each a name and an event |
open_funnel | boolean | true: people can enter at any step Default false. |
breakdown | string | GA4 dimension, e.g. deviceCategory |
start_date | string | YYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "28daysAgo". |
end_date | string | YYYY-MM-DD, "today", "yesterday" or "NdaysAgo" Default "yesterday". |
connection | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
property_id required | string | GA4 property id from list_marketing_accounts (optional with one property) |
search | string | Only fields whose name or description contains this |
connection | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
customer_id required | string | Customer id from list_marketing_accounts (dashes optional) |
query required | string | GAQL SELECT statement |
limit | integer | Most results to return Default 500. |
connection | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
account_id required | string | Account id from list_marketing_accounts (optional with one account) |
connection | string | Connection 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":"…"}'meta_ads_campaignsReadMeta Ads campaigns
Campaign settings in a Meta (Facebook and Instagram) ad account: status, objective, daily or lifetime budget (in the account's currency) and bid strategy. For results, use get_marketing_data with connector meta_ads.
| Argument | Type | What it is |
|---|---|---|
account_id required | string | Ad account id from list_marketing_accounts (with or without act_) |
connection | string | Connection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically. |
Example request
curl https://app.plugsight.app/v1/tools/meta_ads_campaigns \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"account_id":"…"}'linkedin_ads_campaignsReadLinkedIn Ads campaigns
Campaign settings in a LinkedIn ad account: status, type, objective, campaign group, daily and total budget (in the account's currency), bid and schedule. For results, use get_marketing_data with connector linkedin_ads.
| Argument | Type | What it is |
|---|---|---|
account_id required | string | Ad account id from list_marketing_accounts |
connection | string | Connection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically. |
Example request
curl https://app.plugsight.app/v1/tools/linkedin_ads_campaigns \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"account_id":"…"}'tiktok_ads_campaignsReadTikTok Ads campaigns
Campaign settings in a TikTok ad account (advertiser): status, delivery status, objective and budget (daily or total, in the account's currency). For results, use get_marketing_data with connector tiktok_ads.
| Argument | Type | What it is |
|---|---|---|
account_id required | string | Advertiser id from list_marketing_accounts |
connection | string | Connection id from list_marketing_accounts. Optional: a connection that reaches the resource is picked automatically. |
Example request
curl https://app.plugsight.app/v1/tools/tiktok_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.
| Argument | Type | What it is |
|---|---|---|
account | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
from required | string | Start: ISO date-time or YYYY-MM-DD |
to required | string | End: ISO date-time or YYYY-MM-DD (inclusive for dates) |
query | string | Text to match in title, description, location or attendees |
calendar_id | string | One calendar id from calendar_list_calendars; default all visible |
time_zone | string | IANA time zone for dates and times given without an offset, e.g. "Europe/London". Default: the calendar's own |
limit | integer | Most events to return Default 100. |
account | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
event_id required | string | Event id from calendar_list_events |
calendar_id | string | The event's calendar_id from calendar_list_events; default: look in each visible calendar |
account | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
from required | string | Start: ISO date-time or YYYY-MM-DD |
to required | string | End: ISO date-time or YYYY-MM-DD (inclusive for dates) |
time_zone | string | IANA time zone for dates and times given without an offset, e.g. "Europe/London". Default: the calendar's own |
min_minutes | integer | Shortest free gap worth listing, in minutes Default 30. |
account | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
title required | string | Event title |
start required | string | ISO date-time with offset, or YYYY-MM-DD for all day |
end required | string | ISO date-time with offset, or YYYY-MM-DD (exclusive) for all day |
time_zone | string | IANA zone, e.g. "Europe/London"; default the calendar's |
description | string | Description |
location | string | Location |
guests | array of string | Email addresses to invite |
google_meet | boolean | Add a Google Meet video link (Google calendars only) Default false. |
notify_guests | boolean | Email the guests (invitations, updates or cancellation) Default true. |
calendar_id | string | Default: the primary calendar |
account | string | Connection id from list_accounts (optional when there's only one of this type) |
confirm required | boolean | Must 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.
| Argument | Type | What it is |
|---|---|---|
event_id required | string | Event id from calendar_list_events |
calendar_id | string | The event's calendar; default the primary calendar |
title | string | New title |
start | string | New start, ISO 8601 date-time |
end | string | New end, ISO 8601 date-time |
time_zone | string | IANA time zone, e.g. Europe/London |
description | string | Description |
location | string | Location |
add_guests | array of string | Guest email addresses to invite |
notify_guests | boolean | Email the guests (invitations, updates or cancellation) Default true. |
account | string | Connection id from list_accounts (optional when there's only one of this type) |
confirm required | boolean | Must 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.
| Argument | Type | What it is |
|---|---|---|
event_id required | string | Event id from calendar_list_events |
calendar_id | string | Calendar id from calendar_list_calendars (default: the main calendar) |
notify_guests | boolean | Email the guests (invitations, updates or cancellation) Default true. |
account | string | Connection id from list_accounts (optional when there's only one of this type) |
confirm required | boolean | Must 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_searchReadSearch contacts
Finds people by name, email, phone or company. Google also searches 'other contacts' (people you've emailed); iCloud and Outlook search the whole address book. Returns { contacts, note }: a note means some contacts couldn't be searched, and says why.
| Argument | Type | What it is |
|---|---|---|
query required | string | Name, email, phone number or company |
limit | integer | Most results to return Default 20. |
account | string | Connection id from list_accounts (optional when there's only one of this type) |
Example request
curl https://app.plugsight.app/v1/tools/contacts_search \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"…"}'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.
| Argument | Type | What it is |
|---|---|---|
limit | integer | Most results to return Default 100. |
page_token | string | next_page_token from the previous page |
account | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
id required | string | Contact id from contacts_search or contacts_list |
account | string | Connection 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.
| Argument | Type | What it is |
|---|---|---|
from required | string | YYYY-MM-DD |
to required | string | YYYY-MM-DD |
top_products | integer | How many best-selling products to list Default 10. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
status | string | Status One of: any, pending, processing, on-hold, completed, cancelled, refunded, failed, checkout-draft. Default "any". |
from | string | YYYY-MM-DD |
to | string | YYYY-MM-DD |
search | string | Search text |
limit | integer | Most results to return Default 25. |
page | integer | Page of results, from 1 Default 1. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
order_id required | integer | Order number |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
search | string | Search text |
sku | string | Product SKU |
stock_status | string | Only products with this stock status One of: instock, outofstock, onbackorder. |
orderby | string | Sort products by One of: popularity, date, title, price, rating. Default "popularity". |
include_variations | boolean | Also list each variable product's variations with SKU, price and stock Default false. |
limit | integer | Most results to return Default 25. |
page | integer | Page of results, from 1 Default 1. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
search | string | Name or email |
limit | integer | Most results to return Default 25. |
page | integer | Page of results, from 1 Default 1. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
from required | string | YYYY-MM-DD (UTC) |
to required | string | YYYY-MM-DD (UTC) |
top_products | integer | How many best-selling products to list Default 10. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
status | string | e.g. pending, processing, complete, canceled, closed, holded |
from | string | YYYY-MM-DD (UTC) |
to | string | YYYY-MM-DD (UTC) |
email | string | Customer email, or part of it |
limit | integer | Most results to return Default 25. |
page | integer | Page of results, from 1 Default 1. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
order required | string | Order number as customers see it, or the id from magento_list_orders |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
search | string | Part of the product name |
sku | string | SKU, or part of it |
low_stock_below | integer | Only products with less stock than this |
limit | integer | Most results to return Default 25. |
page | integer | Page of results, from 1 Default 1. |
account | string | Store 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.
| Argument | Type | What it is |
|---|---|---|
email | string | Email, or part of it |
name | string | First or last name, or part of it |
limit | integer | Most results to return Default 25. |
page | integer | Page of results, from 1 Default 1. |
account | string | Store 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 '{}'Shopify 6 tools
Needs: A Shopify store
shopify_sales_reportReadShopify sales
Sales for a period from a Shopify store, added up from every order in it: revenue (order totals), orders, items, average order, discounts, shipping, tax and refunds, a per-day breakdown and the best-selling products. Only paid orders count (paid, partially paid, partially refunded, refunded); pending, authorised-only, voided and expired payments, cancelled orders and test orders are listed separately under excluded. Amounts are in the store's currency. On very busy stores or long periods the report can stop early: then complete is false and covered_through says how far it got. complete is also false when the period starts more than 60 days ago and the store's app lacks read_all_orders; note says why. Dates are UTC. Pass account to choose the store when several are connected.
| Argument | Type | What it is |
|---|---|---|
from required | string | YYYY-MM-DD (UTC) |
to required | string | YYYY-MM-DD (UTC) |
top_products | integer | How many best-selling products to list Default 10. |
account | string | Store connection id from list_accounts (optional when there's only one store) |
Example request
curl https://app.plugsight.app/v1/tools/shopify_sales_report \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"from":"2026-11-01","to":"2026-11-15"}'shopify_list_ordersReadList Shopify orders
Orders, newest first, optionally by status, payment status, fulfilment status, date range (UTC), customer email or free text. Use shopify_get_order for the items, addresses, shipping, tracking and refunds of one order.
| Argument | Type | What it is |
|---|---|---|
status | string | Order status: open, closed (archived), cancelled, or any One of: open, closed, cancelled, any. Default "any". |
payment | string | Payment (financial) status One of: paid, pending, authorized, partially_paid, partially_refunded, refunded, voided, expired. |
fulfilment | string | Fulfilment status: shipped, partial, unshipped (none shipped), unfulfilled (not fully shipped), on_hold or scheduled One of: shipped, partial, unshipped, unfulfilled, on_hold, scheduled. |
from | string | YYYY-MM-DD (UTC) |
to | string | YYYY-MM-DD (UTC) |
email | string | Customer email |
search | string | Free text: an order number, customer name, product title or SKU |
limit | integer | Most results to return Default 25. |
cursor | string | next_cursor from the previous page, for the page after it |
account | string | Store connection id from list_accounts (optional when there's only one store) |
Example request
curl https://app.plugsight.app/v1/tools/shopify_list_orders \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'shopify_get_orderReadRead a Shopify order
One order in full by its order number (e.g. #1001) or id: items with variant, SKU, quantities still to ship and refunded, totals, discount codes, shipping method, tax, payment gateways, addresses, note and tags, its fulfilments with tracking numbers, and its refunds.
| Argument | Type | What it is |
|---|---|---|
order required | string | Order number as customers see it (e.g. #1001), or the id from shopify_list_orders |
account | string | Store connection id from list_accounts (optional when there's only one store) |
Example request
curl https://app.plugsight.app/v1/tools/shopify_get_order \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"order":"…"}'shopify_search_productsReadSearch Shopify products
Products by title, SKU, vendor or type, with status, price range, total stock and their variants (price, compare-at price, SKU, stock). Set low_stock_below to list variants whose stock is at or under that quantity instead, lowest first.
| Argument | Type | What it is |
|---|---|---|
search | string | Words in the product title, or other free text |
sku | string | A variant's SKU |
vendor | string | The product vendor (brand or supplier), as set on the product |
product_type | string | The product type, as set on the product |
status | string | Status One of: active, draft, archived. |
low_stock_below | integer | List variants with this many or fewer in stock (tracked inventory only) |
limit | integer | Most results to return Default 25. |
cursor | string | next_cursor from the previous page, for the page after it |
account | string | Store connection id from list_accounts (optional when there's only one store) |
Example request
curl https://app.plugsight.app/v1/tools/shopify_search_products \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'shopify_inventoryReadShopify stock by location
Stock of one product's variants at each location: available, on hand, committed (ordered, not yet shipped) and incoming. Find the product by SKU or by its id from shopify_search_products.
| Argument | Type | What it is |
|---|---|---|
sku | string | A variant's SKU |
product_id | string | Product id from shopify_search_products |
account | string | Store connection id from list_accounts (optional when there's only one store) |
Example request
curl https://app.plugsight.app/v1/tools/shopify_inventory \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'shopify_search_customersReadSearch Shopify customers
Customers by name, email or other text, with their order count, amount spent, when they joined, tags and location. Use shopify_list_orders with email for their orders.
| Argument | Type | What it is |
|---|---|---|
search | string | Name, email, phone or other text |
email | string | Exact email address |
limit | integer | Most results to return Default 25. |
cursor | string | next_cursor from the previous page, for the page after it |
account | string | Store connection id from list_accounts (optional when there's only one store) |
Example request
curl https://app.plugsight.app/v1/tools/shopify_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.
| Argument | Type | What it is |
|---|---|---|
account | string | Mailchimp 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.
| Argument | Type | What it is |
|---|---|---|
status | string | sent (default), save (drafts), schedule, sending, paused One of: sent, save, schedule, sending, paused. Default "sent". |
sent_from | string | YYYY-MM-DD |
sent_to | string | YYYY-MM-DD |
audience_id | string | Audience id from mailchimp_list_audiences |
limit | integer | Most results to return Default 25. |
offset | integer | Results to skip, for paging Default 0. |
account | string | Mailchimp 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.
| Argument | Type | What it is |
|---|---|---|
campaign_id required | string | Campaign id from mailchimp_list_campaigns |
top_links | integer | How many most-clicked links to list Default 10. |
account | string | Mailchimp 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.
| Argument | Type | What it is |
|---|---|---|
audience_id required | string | Audience id from mailchimp_list_audiences |
months | integer | How many months back Default 12. |
account | string | Mailchimp 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.
| Argument | Type | What it is |
|---|---|---|
query required | string | Email address, or part of a name or email |
audience_id | string | Only this audience |
account | string | Mailchimp 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.
| Argument | Type | What it is |
|---|---|---|
include_emails | boolean | Also list each automation's emails with their delay and results Default false. |
account | string | Mailchimp 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.
| Argument | Type | What it is |
|---|---|---|
audience_id required | string | Audience id from mailchimp_list_audiences |
account | string | Mailchimp 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":"…"}'Bing Webmaster Tools 5 tools
Needs: A Bing Webmaster Tools connection (Pro and Agency; Free can try 1 connection and 25 calls a month)
bing_webmaster_sitesReadList Bing Webmaster sites
The sites in this Bing Webmaster Tools account that AI apps may use, and whether each is verified. Use a site's URL in the other Bing Webmaster tools.
| Argument | Type | What it is |
|---|---|---|
account | string | Bing Webmaster connection id from list_accounts (optional when there's only one) |
Example request
curl https://app.plugsight.app/v1/tools/bing_webmaster_sites \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'bing_webmaster_search_performanceReadBing search performance
How a site does in Bing search: clicks and impressions by day, and its top search queries and pages with clicks, impressions, CTR and average position. Bing keeps about six months and reports queries and pages by week, so from/to pick whole weeks. Default: everything Bing has.
| Argument | Type | What it is |
|---|---|---|
account | string | Bing Webmaster connection id from list_accounts (optional when there's only one) |
site_url | string | Site exactly as bing_webmaster_sites lists it, e.g. https://example.com/ (optional when the account has one) |
from | string | YYYY-MM-DD |
to | string | YYYY-MM-DD |
top | integer | How many top queries and pages (by clicks) Default 25. |
sort_by | string | Field to sort by One of: clicks, impressions. Default "clicks". |
Example request
curl https://app.plugsight.app/v1/tools/bing_webmaster_search_performance \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'bing_webmaster_crawlReadBing crawl stats
How Bing crawls a site, day by day: pages crawled, pages in the index, crawl errors, blocked by robots.txt, and responses by status (2xx, 301, 4xx, 5xx). About six months.
| Argument | Type | What it is |
|---|---|---|
account | string | Bing Webmaster connection id from list_accounts (optional when there's only one) |
site_url | string | Site exactly as bing_webmaster_sites lists it, e.g. https://example.com/ (optional when the account has one) |
from | string | YYYY-MM-DD |
to | string | YYYY-MM-DD |
Example request
curl https://app.plugsight.app/v1/tools/bing_webmaster_crawl \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'bing_webmaster_sitemapsReadBing sitemaps
The sitemaps and feeds submitted for a site in Bing Webmaster Tools, with what Bing reports for each.
| Argument | Type | What it is |
|---|---|---|
account | string | Bing Webmaster connection id from list_accounts (optional when there's only one) |
site_url | string | Site exactly as bing_webmaster_sites lists it, e.g. https://example.com/ (optional when the account has one) |
Example request
curl https://app.plugsight.app/v1/tools/bing_webmaster_sitemaps \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'bing_webmaster_url_infoReadBing index details for a page
What Bing knows about one page of a site: whether and when it was discovered and crawled, and its index details.
| Argument | Type | What it is |
|---|---|---|
account | string | Bing Webmaster connection id from list_accounts (optional when there's only one) |
site_url | string | Site exactly as bing_webmaster_sites lists it, e.g. https://example.com/ (optional when the account has one) |
url required | string | The page's full URL |
Example request
curl https://app.plugsight.app/v1/tools/bing_webmaster_url_info \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"…"}'Custom API 2 tools
Needs: A Custom API connection (Pro and Agency). Each imported OpenAPI operation also becomes its own tool, named after the connection
custom_api_operationsReadList a Custom API's operations
Lists the operations imported from a Custom API connection's OpenAPI spec: each one's operation_id, method, path, summary, parameters and body schema, and its own tool name when it has one. Call one with its tool, or with custom_api_request and operation_id. Use search to narrow a long list.
| Argument | Type | What it is |
|---|---|---|
account | string | Custom API connection id from list_accounts (optional when there's only one) |
search | string | Only operations whose id, path or summary contain these words |
limit | integer | Most operations to return (default 100) |
Example request
curl https://app.plugsight.app/v1/tools/custom_api_operations \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'custom_api_requestChangeCall a Custom API
Sends one HTTP request to a Custom API connection, signed with its saved credentials. Give a method and a path under the connection's base URL (never a full address), or an imported operation's operation_id with its params. GET and HEAD only read. Changes also need changes allowed for the connection and the MCP server. Any HTTP status comes back as data, with the body (JSON parsed; long bodies are cut at about 100,000 characters and marked truncated).
Makes a change, so it needs "confirm": true and changes allowed. How changes work.
| Argument | Type | What it is |
|---|---|---|
account | string | Custom API connection id from list_accounts (optional when there's only one) |
method | string | HTTP method (default GET) One of: GET, HEAD, POST, PUT, PATCH, DELETE. |
path | string | Path under the base URL, like /users/42 |
query | object | Query string parameters, by name |
body | any | Request body: JSON (sent as application/json) or a string (sent as text) |
headers | object | Extra request headers. Not Authorization, cookies or the connection's own headers |
operation_id | string | An imported operation's id from custom_api_operations, instead of method and path |
params | object | With operation_id: its path, query and header parameters, by name (or by location and name, like "query:id", when two share a name) |
confirm | boolean | Must be true for POST, PUT, PATCH and DELETE: the user approved this exact request |
Example request
curl https://app.plugsight.app/v1/tools/custom_api_request \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"confirm":true}'Custom MCP server 1 tool
Needs: A custom MCP server connection (Pro and Agency). Each of the server's own tools also becomes a tool, named after the connection
custom_mcp_refresh_toolsReadRefresh a custom MCP server's tools
Lists a custom MCP server's tools again now, instead of using the list Plugsight keeps for a few minutes, and says how many only read and how many make changes. If its tools changed, the AI app needs to reload Plugsight's tool list to see them.
| Argument | Type | What it is |
|---|---|---|
account | string | Custom MCP server connection id from list_accounts (optional when there's only one) |
Example request
curl https://app.plugsight.app/v1/tools/custom_mcp_refresh_tools \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'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.
| Argument | Type | What it is |
|---|---|---|
url required | string | The page to check, e.g. https://example.com/pricing |
strategy | string | Mobile is what Google ranks on One of: mobile, desktop. Default "mobile". |
categories | array of string | Which 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:
- Web pageCalls
/api/statson your own site. - Your serverAdds the key, calls Plugsight, keeps only the numbers the page needs.
- 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, Meta Ads, LinkedIn Ads, Google Search Console, Google Analytics 4, WooCommerce, Magento / Adobe Commerce, Shopify, Mailchimp, Custom API, Custom MCP server, Gmail, Outlook & Microsoft 365, iCloud Mail, Any email (IMAP), Zendesk, Google Calendar, Outlook Calendar, Outlook Contacts, iCloud Calendar, iCloud Contacts, Google Contacts and Bing Webmaster Tools. 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.