Công cụ MCP
Mọi công cụ MCP mà máy chủ đăng ký, được tạo từ chính sổ đăng ký: tên, chức năng và đối số. CI tạo lại bảng này ở mỗi thay đổi.
| Tool | What it does | Arguments |
|---|---|---|
| prodantix.accounts.create | Create another prodantix account for yourself. | label?: string, company_id?: string |
| prodantix.accounts.list | Your prodantix accounts and which one is active. | company_id?: string |
| prodantix.accounts.rename | Rename one of your prodantix accounts. | account_no: integer, label?: string, company_id?: string |
| prodantix.accounts.switch | Act as another of your prodantix accounts. | account_no: integer, company_id?: string |
| prodantix.ai.account | The company's own AI account when it has connected one, on Enterprise: the provider, the key's last four characters, a Model Studio region and workspace where there is one, and who connected it when. Null when AI runs on Prodantix AI. The key itself is never returned. | company_id?: string |
| prodantix.ai.account_models | The models the company's own AI account lists that answer text, by id and name. Empty for a provider with no model list, whose model is typed by name. | company_id?: string |
| prodantix.ai.answer | Answer a question about a project from a query's result, in plain language. | project_id: string, question: string, query: string, company_id?: string |
| prodantix.ai.card_on_file | Whether the company has a default card on file, which turning the AI add-on on requires unless the company is whitelisted. | company_id?: string |
| prodantix.ai.disable | Turn the AI add-on off, which stops AI for the company. Its model and limits are kept. | company_id?: string |
| prodantix.ai.insights | Notable changes in an event between two dates. | project_id: string, event: string, from: string, to: string, threshold?: number, company_id?: string |
| prodantix.ai.limit_suggestion | A suggested company limit in money, in micros: the monthly price of the company's plan, or of the nearest priced plan. | company_id?: string |
| prodantix.ai.limits | The company's AI spend limits, the company-wide one and one per member, each with what is used and left this month. | limit?: integer, after?: string, company_id?: string |
| prodantix.ai.members | The company's members with their ids, names and emails, and the caller's own id: the ids a member's spend limit and a member recipient take. | limit?: integer, after?: string, company_id?: string |
| prodantix.ai.models | The models the AI add-on offers, each with its price per million tokens. | company_id?: string |
| prodantix.ai.remove_limit | Remove an AI spend limit by id, so the spend it covered is no longer capped or warned about. | id: string, company_id?: string |
| prodantix.ai.seats | The members counted as seats on the company's own AI account for a month written YYYY-MM, the current one by default: each member who made at least one AI request that month, their count and the price per seat in cents. | month?: string, limit?: integer, after?: string, company_id?: string |
| prodantix.ai.set_limit | Set the company's AI spend limit, or one member's with member_id, replacing the one it had. AI stops when the amount is reached. unit is tokens or money, a money amount in micros; thresholds are warning percentages from 1 to 99; each recipient is alerted and has kind member, role or email with its value. | member_id?: string, unit: string, amount: integer, thresholds: array, recipients: array, company_id?: string |
| prodantix.ai.set_model | Change the model the AI add-on runs. Refused for a model prodantix.ai.models does not list. | model: string, company_id?: string |
| prodantix.ai.settings | Whether the AI add-on is on for the company, the model it runs and when it was turned on. | company_id?: string |
| prodantix.ai.spend_by_month | The company's AI spend for each month of a year, in tokens and micros, and the members counted as seats on its own AI account, with zero for a month without use. The year defaults to the current UTC year; one before the company was created or after the current one is refused. | year?: integer, company_id?: string |
| prodantix.ai.translate_query | Turn a plain-language question into an analytics query. | project_id: string, question: string, company_id?: string |
| prodantix.ai.usage | The company's AI spend for a month written YYYY-MM, the current one by default: totals in tokens and micros, by member, surface and model, and each limit with what is left when the month is current. | month?: string, limit?: integer, after?: string, company_id?: string |
| prodantix.ai.usage_months | The months that carry AI usage, newest first. | company_id?: string |
| prodantix.ai.whitelisted | Whether the company is whitelisted: its AI is on from the start, turning AI on never needs a card, and its AI use is never charged. | company_id?: string |
| prodantix.analytics.crossed_watches | Saved insights whose watch threshold has been crossed. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.analytics.funnel | Conversion through ordered steps. The query is the console's funnel definition as JSON, in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, query: object | array | string | number | boolean | null, report_id?: string, company_id?: string |
| prodantix.analytics.lifecycle | New, returning, resurrecting and dormant people per period. The query is JSON, in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, query: object | array | string | number | boolean | null, report_id?: string, company_id?: string |
| prodantix.analytics.paths | The most common paths before or after an event. The query is JSON, in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, query: object | array | string | number | boolean | null, report_id?: string, company_id?: string |
| prodantix.analytics.paths_pages | The most visited pages in a date range. | project_id: string, date_range: object, company_id?: string |
| prodantix.analytics.retention | How many people come back after a starting event. The query is JSON, in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, query: object | array | string | number | boolean | null, report_id?: string, company_id?: string |
| prodantix.analytics.runQuery | Run an aggregation over a project's event stream: one or more lettered metrics (A, B, ...), formulas over their letters (A / B), up to three breakdowns and a compared period (previous_period, previous_day, previous_week, previous_month, previous_quarter, previous_year). | project_id: string, event: string, measure_kind: string, measure_property?: string | null, metrics?: array | null, formulas?: array | null, breakdowns?: array | null, compare?: string | null, granularity: string, from: string, to: string, limit?: integer | null, company_id?: string |
| prodantix.analytics.stickiness | How many days in each period people did something. The query is JSON, in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, query: object | array | string | number | boolean | null, report_id?: string, company_id?: string |
| prodantix.annotations.create | Mark a day, or a range of days, on a project's charts with a note and one to ten tags. Name a report to keep it to that report; without one it shows on every chart in the project whose dates cover it. | project_id: string, report_id?: string, starts_on: string, ends_on?: string, text: string, tags: array, company_id?: string |
| prodantix.annotations.list | A project's annotations whose days overlap a window, both days written YYYY-MM-DD, earliest first, at most 500 a page; for the next page, pass the last annotation's id as after. Name a report to add that report's own annotations to the project's. | project_id: string, report_id?: string, from: string, to: string, limit?: integer, after?: string, company_id?: string |
| prodantix.billing.cancel | Cancel the subscription at the end of the current period. | company_id?: string |
| prodantix.billing.meter_blocked | Whether one plan metric is blocked for the rest of the period. | metric: string, company_id?: string |
| prodantix.billing.plan_allowance | How much of one plan metric the company has used and may use. The metric is one of max_projects, max_members, max_saved_insights, max_dashboards, max_alerts, max_active_workflows or max_active_experiments. | metric: string, company_id?: string |
| prodantix.billing.plan_change_preview | What changing plan would charge or credit now. | plan: object, company_id?: string |
| prodantix.billing.plan_feature | Whether the company's plan includes one feature. | feature: string, company_id?: string |
| prodantix.billing.portal | Answer a link to the billing portal. | company_id?: string |
| prodantix.billing.standing | Whether a payment has failed, and the date the team loses access if it stays unpaid. | company_id?: string |
| prodantix.billing.state | The company's plan, status and usage. | company_id?: string |
| prodantix.billing.tier_limits | Every plan's limits. | company_id?: string |
| prodantix.cohorts.add_members | Add distinct ids to a static cohort. | project_id: string, cohort_id: string, distinct_ids: array, company_id?: string |
| prodantix.cohorts.create | Create a cohort from a definition, as JSON: its state and behavioural clauses are described at https://prodantix.com/en/docs/console-cohorts, and prodantix.cohorts.get shows an existing cohort's. | project_id: string, name: string, definition: object | array | string | number | boolean | null, company_id?: string |
| prodantix.cohorts.create_from_result | Create a cohort from the people behind one bar or step of an analytics result. The query is that result's report query as JSON, in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, name: string, kind: string, label: string, query: object | array | string | number | boolean | null, company_id?: string |
| prodantix.cohorts.create_static | Create a cohort from a list of distinct ids. | project_id: string, name: string, distinct_ids: array, company_id?: string |
| prodantix.cohorts.delete | Delete a cohort. | project_id: string, cohort_id: string, company_id?: string |
| prodantix.cohorts.get | One cohort and its definition. | project_id: string, cohort_id: string, company_id?: string |
| prodantix.cohorts.list | A project's cohorts. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.cohorts.member_count | How many people are in a cohort. | project_id: string, cohort_id: string, company_id?: string |
| prodantix.cohorts.members | A page of a cohort's members. | project_id: string, cohort_id: string, limit?: integer, offset?: integer, company_id?: string |
| prodantix.cohorts.remove_members | Remove distinct ids from a static cohort. | project_id: string, cohort_id: string, distinct_ids: array, company_id?: string |
| prodantix.cohorts.set_active | Stop or restart a cohort's membership updates. | project_id: string, cohort_id: string, is_active: boolean, company_id?: string |
| prodantix.cohorts.update | Rename a cohort or change its definition, as JSON in the shape https://prodantix.com/en/docs/console-cohorts describes; prodantix.cohorts.get shows the current one. | project_id: string, cohort_id: string, name?: string, definition?: object | array | string | number | boolean | null, company_id?: string |
| prodantix.companies.list | The companies you belong to and the active one. | company_id?: string |
| prodantix.company.audit_events | The company's audit log, newest first: sign-ins, member and role changes, single sign-on, SCIM, keys, exports and settings, each with who acted, when and from which address. At most 500 a page; pass the last page's prodantixBefore and identityBefore for the next. identityMissing says sign-in and member entries could not be read. | limit?: integer, prodantix_before?: string, identity_before?: string, company_id?: string |
| prodantix.company.rename | Rename the company. Only an agent with full access can hold this permission. | name: string, company_id?: string |
| prodantix.conversations.assign | Assign a conversation to you, or unassign it. | project_id: string, conversation_id: string, to_me: boolean, company_id?: string |
| prodantix.conversations.counts | How many conversations are open, assigned to you, flagged and so on. | project_id: string, company_id?: string |
| prodantix.conversations.draft_reply | Draft a reply to a conversation. Nothing is sent. | project_id: string, conversation_id: string, company_id?: string |
| prodantix.conversations.flag | Flag or unflag a conversation. | project_id: string, conversation_id: string, flagged: boolean, company_id?: string |
| prodantix.conversations.get | One conversation with its turns. | project_id: string, id: string, limit?: integer, before?: string, company_id?: string |
| prodantix.conversations.list | A page of a project's inbox conversations, optionally filtered. | project_id: string, status?: string, assigned_to_me?: boolean, flagged?: boolean, handed_over?: boolean, held_as_spam?: boolean, search?: string, cursor_last_turn_at?: string, cursor_id?: string, limit?: integer, company_id?: string |
| prodantix.conversations.mark_read | Mark a conversation as read. | project_id: string, conversation_id: string, company_id?: string |
| prodantix.conversations.not_spam | Restore a conversation held as spam to the inbox. | project_id: string, conversation_id: string, company_id?: string |
| prodantix.conversations.propose_action | Propose an action for a conversation, for a person to approve. | project_id: string, conversation_id: string, company_id?: string |
| prodantix.conversations.reply | Send a reply in a conversation. | project_id: string, conversation_id: string, body: string, company_id?: string |
| prodantix.conversations.set_status | Open, close or snooze a conversation. | project_id: string, conversation_id: string, status: string, snoozed_until?: string, company_id?: string |
| prodantix.copy.apply | Apply a copy plan by its fingerprint. Each copied item is checked against its own permission. | input: object, fingerprint: string, company_id?: string |
| prodantix.copy.plan | What copying configuration from one project to another would create, update or skip, with a fingerprint to apply it. Each object names its kind (environment, integrations, cohorts, flags, experiments, dashboards, workflows or messenger) and its identity within that kind, such as a flag's key. | input: object, company_id?: string |
| prodantix.dashboards.create | Create a dashboard with tiles. | project_id: string, name: string, tiles: array, company_id?: string |
| prodantix.dashboards.delete | Delete a dashboard. The insights on it are kept. | project_id: string, dashboard_id: string, company_id?: string |
| prodantix.dashboards.list | A project's dashboards and their tiles. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.dashboards.update | Rename a dashboard or replace its tiles. | project_id: string, dashboard_id: string, name?: string, tiles?: array, company_id?: string |
| prodantix.events.catalog | Every event name and property a project has seen. | project_id: string, company_id?: string |
| prodantix.events.list | A page of a project's raw events, newest first, optionally filtered. filter.point, given as prodantix.people.list describes it, keeps only the events behind that point. Its query is JSON in the format https://prodantix.com/en/docs/analytics describes. | project_id: string, filter?: object, limit?: integer, cursor?: string, company_id?: string |
| prodantix.experiments.conclude | End an experiment, record the winner and optionally ship it. | project_id: string, key: string, winner?: string, conclusion?: string, ship: boolean, company_id?: string |
| prodantix.experiments.create | Create an experiment in draft. | project_id: string, input: object, company_id?: string |
| prodantix.experiments.delete | Delete an experiment. | project_id: string, key: string, company_id?: string |
| prodantix.experiments.get | One experiment and its setup. | project_id: string, key: string, company_id?: string |
| prodantix.experiments.list | A project's experiments, newest first, at most 500 a page; for the next page, pass the last experiment's key as after. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.experiments.results | An experiment's results by variation. | project_id: string, key: string, company_id?: string |
| prodantix.experiments.start | Start an experiment. | project_id: string, key: string, company_id?: string |
| prodantix.experiments.stop | Pause an experiment without concluding it. | project_id: string, key: string, company_id?: string |
| prodantix.experiments.update | Change an experiment's setup. | project_id: string, key: string, input: object, company_id?: string |
| prodantix.flags.approve | Approve a flag change request, which applies it. | project_id: string, id: string, comment?: string, company_id?: string |
| prodantix.flags.archive | Archive a feature flag so it stops serving. It can be restored. | project_id: string, key: string, company_id?: string |
| prodantix.flags.archived | A project's archived feature flags, newest archive first, at most 500 a page; for the next page, pass the last flag's key as after. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.flags.cancel_rollout | Stop a rollout where it is. | project_id: string, id: string, company_id?: string |
| prodantix.flags.change_request | One flag change request with its diff and reviews. | project_id: string, id: string, company_id?: string |
| prodantix.flags.change_requests | A project's flag change requests, newest first, optionally only those with one status, at most 500 a page; for the next page, pass the last request's id as after. | project_id: string, status?: string, limit?: integer, after?: string, company_id?: string |
| prodantix.flags.history | A flag's versions, newest first, with who changed what and how. | project_id: string, key: string, limit?: integer, before?: string, company_id?: string |
| prodantix.flags.list | A project's live feature flags with their rules, ordered by key, at most 500 a page; for the next page, pass the last flag's key as after. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.flags.promote | Copy a flag's rules from one project to another. | from_project_id: string, to_project_id: string, key: string, company_id?: string |
| prodantix.flags.promotion_diff | How a flag differs between two projects, usually test and live. | from_project_id: string, to_project_id: string, key: string, company_id?: string |
| prodantix.flags.propose | Submit a flag change for review. The change is a JSON-encoded string: { kind: upsert, flag } | { kind: archive } | { kind: restore } | { kind: start_rollout, rollout }. | project_id: string, change: string, key?: string, comment?: string, company_id?: string |
| prodantix.flags.reject | Reject a flag change request. | project_id: string, id: string, comment?: string, company_id?: string |
| prodantix.flags.restore | Bring an archived flag back. | project_id: string, key: string, company_id?: string |
| prodantix.flags.review_required | Whether flag changes in a project must be reviewed. | project_id: string, company_id?: string |
| prodantix.flags.rollback_rollout | Stop a rollout and return the flag to where it started. | project_id: string, id: string, company_id?: string |
| prodantix.flags.rollouts | A project's staged flag rollouts, newest first, optionally for one flag, at most 500 a page; for the next page, pass the last rollout's id as after. | project_id: string, key?: string, limit?: integer, after?: string, company_id?: string |
| prodantix.flags.start_rollout | Start a staged rollout of a flag. The rollout is a JSON-encoded object { variation, fromVariation, steps }: variation is the one that grows (true for a boolean flag), fromVariation the one it takes weight from (false), and steps one to twenty { at, percentage }, each at an RFC 3339 time later than the one before and each percentage higher. | project_id: string, key: string, rollout: string, company_id?: string |
| prodantix.flags.upsert | Create a feature flag or change an existing one. Refused when the project requires review; use prodantix.flags.propose there. | project_id: string, flag: object, company_id?: string |
| prodantix.flags.withdraw | Withdraw your own pending change request. | project_id: string, id: string, company_id?: string |
| prodantix.insights.clear_watch | Remove a saved insight's watch. | project_id: string, insight_id: string, company_id?: string |
| prodantix.insights.create | Save a query as a named insight. The query is JSON in the format https://prodantix.com/en/docs/analytics describes, and the chart settings are described at https://prodantix.com/en/docs/console-analytics. | project_id: string, name: string, query: object | array | string | number | boolean | null, kind: string, viz: string, chart?: object | array | string | number | boolean | null, company_id?: string |
| prodantix.insights.delete | Delete a saved insight. | project_id: string, insight_id: string, company_id?: string |
| prodantix.insights.list | A project's saved insights. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.insights.update | Change a saved insight's name, query, kind or chart. The query is JSON in the format https://prodantix.com/en/docs/analytics describes, and the chart settings are described at https://prodantix.com/en/docs/console-analytics. | project_id: string, insight_id: string, name?: string, query?: object | array | string | number | boolean | null, kind?: string, viz?: string, chart?: object | array | string | number | boolean | null, company_id?: string |
| prodantix.insights.watch | Alert when a saved insight crosses a bound. | project_id: string, insight_id: string, condition: string, bound: number, company_id?: string |
| prodantix.integrations.add_target | Add a destination to a connection. The secret is sealed and never readable again. | input: object, company_id?: string |
| prodantix.integrations.complete_slack_install | Finish a Slack install with the code Slack returned. | code: string, state: string, company_id?: string |
| prodantix.integrations.connect | Create an integration connection for one project, or for the organisation when no project is given. | input: object, company_id?: string |
| prodantix.integrations.connections | A project's integration connections. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.integrations.disable | Pause or resume a connection. | connection_id: string, disabled: boolean, company_id?: string |
| prodantix.integrations.providers | Every integration prodantix can connect to. | company_id?: string |
| prodantix.integrations.revoke | Revoke a connection for good. | connection_id: string, company_id?: string |
| prodantix.integrations.send_test | Send a test through a connection and report what happened. | project_id: string, connection_id: string, target_id?: string, channel?: object, email_to?: string, company_id?: string |
| prodantix.integrations.set_body_template | Set or clear what a connection sends. | connection_id: string, body_template?: string, company_id?: string |
| prodantix.integrations.set_project | Turn an organisation connection on or off for one project. | connection_id: string, project_id: string, enabled: boolean, company_id?: string |
| prodantix.integrations.set_reach | Choose which projects an organisation connection reaches. | connection_id: string, reach: string, company_id?: string |
| prodantix.integrations.set_test_mode | Choose where a connection sends while testing. | connection_id: string, test_mode: string, company_id?: string |
| prodantix.integrations.slack_channels | The channels a Slack connection can post to. | connection_id: string, company_id?: string |
| prodantix.integrations.start_slack_install | Answer the page where a person installs the Slack app. | connection_id: string, company_id?: string |
| prodantix.me | The signed-in person this agent acts for, and every company its connection covers: each company's companyId and name, and the projects and permissions it was granted there. When there is more than one, name the company in company_id on other calls. A first-party session lists no companies. | |
| prodantix.members.assignable_roles | The roles you may give someone you invite. | company_id?: string |
| prodantix.members.invite | Invite someone to the company by email with one or more roles. The roles' ids come from prodantix.members.assignable_roles, and an agent can only give roles whose permissions it was granted. | email: string, role_ids: array, company_id?: string |
| prodantix.members.list | The company's members and their roles. | query?: string, limit?: integer, identity_subs?: array, after?: string, company_id?: string |
| prodantix.members.pending_invitations | Invitations that have not been accepted. | limit?: integer, after?: string, company_id?: string |
| prodantix.members.resend_invitation | Send a pending invitation again with a fresh link. The old link stops working. | invitation_id: string, company_id?: string |
| prodantix.members.revoke_invitation | Revoke a pending invitation so its link stops working. | invitation_id: string, company_id?: string |
| prodantix.members.roles | The company's roles and what each allows. | company_id?: string |
| prodantix.messages.compose | Send a message to a project's end users in the app, by email or to a webhook. | project_id: string, input: object, company_id?: string |
| prodantix.messages.list | A project's sent campaigns and messages, newest first, 100 a page by default and at most 500; for the next page, pass the last message's createdAt and id as before. | project_id: string, limit?: integer, before?: object, company_id?: string |
| prodantix.messenger.add_knowledge_link | Add a web page the messenger assistant can answer from. | project_id: string, url: string, company_id?: string |
| prodantix.messenger.assistant | The messenger assistant's mode and the sources it answers from. | project_id: string, company_id?: string |
| prodantix.messenger.config | The messenger's settings for a project. | project_id: string, company_id?: string |
| prodantix.messenger.help_centre | The company's Clepit help site as the messenger reads it (its address, articles, languages and last read) and whether visitors can search its articles. | project_id: string, company_id?: string |
| prodantix.messenger.my_profile | The name and picture people see when you answer in the messenger. | company_id?: string |
| prodantix.messenger.remove_knowledge_source | Remove a source the messenger assistant answers from. It names only the source, so it needs every project. | id: string, company_id?: string |
| prodantix.messenger.set_article_search | Let visitors search the help centre's articles in the messenger, and choose where they find them: a Help tab, the first view or while they type. Turning it on needs a plan with article search; the help site's articles are read within five minutes. | project_id: string, on: boolean, placement: string, company_id?: string |
| prodantix.messenger.set_enabled | Show or hide the messenger on every page carrying the snippet. | project_id: string, enabled: boolean, company_id?: string |
| prodantix.messenger.set_team | Choose who answers the messenger. | project_id: string, identity_subs: array, company_id?: string |
| prodantix.messenger.team | Who answers the messenger for a project. | project_id: string, company_id?: string |
| prodantix.messenger.translate | Translate the messenger's texts from one language into another with AI, one translation per text. Nothing is stored: write the result with prodantix.messenger.update_config. | project_id: string, from: string, to: string, texts: array, company_id?: string |
| prodantix.messenger.update_assistant | Choose how the messenger assistant answers. | project_id: string, mode: string, company_id?: string |
| prodantix.messenger.update_config | Change the messenger's settings. The greeting, away message, availability and starter prompts are JSON: https://prodantix.com/en/docs/console-messenger describes each, and prodantix.messenger.config shows the current values. | project_id: string, input: object, company_id?: string |
| prodantix.messenger.update_my_profile | Change the name people see when you answer in the messenger. | name?: string, company_id?: string |
| prodantix.people.erase | Permanently erase one end user from a project: their profile, events, recordings, conversations and every alias linked to them. It cannot be undone. Answers the erasure job; read it with prodantix.people.erasure. | project_id: string, distinct_id: string, company_id?: string |
| prodantix.people.erasure | Where an erasure stands: queued, erasing, waiting for the analytics delete, done or failed, with what each store removed. | project_id: string, id: string, company_id?: string |
| prodantix.people.get | One end user's profile and recent activity. | project_id: string, distinct_id: string, company_id?: string |
| prodantix.people.groups | A project's groups of end users, such as companies. | project_id: string, search?: string, group_type?: string, company_id?: string |
| prodantix.people.list | A page of a project's end users, optionally searched or filtered by group. point narrows it to the people behind one point of a report: kind is trend, funnel, retention, stickiness, lifecycle or paths, and query is that report's definition as JSON, in the format https://prodantix.com/en/docs/analytics describes. A trend point gives its bucket in from and to, its metric or formula by letter and one value per breakdown; a funnel point its step; a retention point its cohort_bucket and period; a stickiness point its period's start date in from and days_active; a lifecycle point its period's start date in from and a state of new, returning, resurrecting or dormant; a paths point its step and event. Steps count from 1. | project_id: string, search?: string, status?: string, group_key?: string, cursor?: string, limit?: integer, point?: object, company_id?: string |
| prodantix.people.merge | Merge one distinct id into another. It cannot be undone. | project_id: string, from_distinct_id: string, to_distinct_id: string, company_id?: string |
| prodantix.projects.allowance | How many projects the company's plan allows and how many it has. | company_id?: string |
| prodantix.projects.archive | Archive a project, both environments, by its slug. It stops taking events. | slug: string, company_id?: string |
| prodantix.projects.create | Create a project, with a live and a test environment, from a slug and a name. | slug: string, name: string, company_id?: string |
| prodantix.projects.groups | Every project in the company grouped with its live and test environments, optionally including archived ones, at most 500 groups a call; pass the last slug as after for the next. | include_archived?: boolean, limit?: integer, after?: string, company_id?: string |
| prodantix.projects.list | Every project in the company, one entry per environment, at most 500 a call; pass the last id as after for the next. Needs access to every project; an agent limited to some projects finds its own with prodantix.me. | limit?: integer, after?: string, company_id?: string |
| prodantix.projects.rename | Rename a project, both environments, by its slug. | slug: string, name: string, company_id?: string |
| prodantix.projects.rotate_key | Issue a new ingest key. The old one keeps working for grace_hours, 1 to 168; without grace_hours it stops working at once. | project_id: string, grace_hours?: integer, company_id?: string |
| prodantix.projects.rotate_signing_secret | Issue a new signing secret. The old one stops working at once. | project_id: string, company_id?: string |
| prodantix.projects.set_flag_review_required | Turn required review of flag changes on or off for a project. | project_id: string, required: boolean, company_id?: string |
| prodantix.projects.set_identity_link | Turn on or off joining a visitor's anonymous activity to the person when they sign in. | project_id: string, enabled: boolean, company_id?: string |
| prodantix.proposals.approve | Approve an AI proposal, which carries it out. | id: string, company_id?: string |
| prodantix.proposals.edit | Change an AI proposal before it is approved. | id: string, proposal: string, company_id?: string |
| prodantix.proposals.list | Actions the AI has proposed, optionally only those with given statuses. | project_id: string, statuses?: array, company_id?: string |
| prodantix.proposals.reject | Reject an AI proposal. | id: string, company_id?: string |
| prodantix.replay.chunks | Short-lived download links to one session's recording, in playback order, at most 500 a page; for the next page, pass the last seq as after. | project_id: string, session_id: string, limit?: integer, after?: integer, company_id?: string |
| prodantix.replay.sessions | A project's recorded sessions. With point, given as prodantix.people.list describes it, only the sessions of the people behind that point, within its from and to when it gives both. Its query is JSON in the format https://prodantix.com/en/docs/analytics describes. Newest first, 200 a page by default and at most 500; for the next page, pass the last session's lastTs and sessionId as before. | project_id: string, point?: object, limit?: integer, before?: object, company_id?: string |
| prodantix.reports.create | Save a query as a named report on a board. A name already on that board is refused. The query is JSON in the format https://prodantix.com/en/docs/analytics describes, and the chart settings are described at https://prodantix.com/en/docs/console-analytics. | project_id: string, board_id: string, name: string, description?: string, query: object | array | string | number | boolean | null, kind: string, viz: string, chart?: object | array | string | number | boolean | null, company_id?: string |
| prodantix.reports.delete | Delete a report. It can be restored for an hour, then it is purged with its tiles. | project_id: string, report_id: string, company_id?: string |
| prodantix.reports.describe | Change a report's description. | project_id: string, report_id: string, description: string, company_id?: string |
| prodantix.reports.duplicate | Copy a report on its board. | project_id: string, report_id: string, company_id?: string |
| prodantix.reports.get | One report with its query, kind and chart. | project_id: string, report_id: string, company_id?: string |
| prodantix.reports.history | A report's saved versions, newest first. | project_id: string, report_id: string, before?: integer, limit?: integer, company_id?: string |
| prodantix.reports.list | A project's reports, newest updated first, each with the board it sits on and its current version, at most 500 a page; for the next page, pass the last report's id as after. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.reports.list_comments | A saved report's comment threads, earliest first, at most 50 a page, each with its comments in order; for the next page, pass the last thread's id as after. A thread on one point of the report names the point in its anchor; a deleted comment keeps its place with no words. | project_id: string, report_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.reports.move | Move a report to another board. A name already on the target board is refused. | project_id: string, report_id: string, board_id: string, company_id?: string |
| prodantix.reports.rename | Rename a report. A name already on its board is refused. | project_id: string, report_id: string, name: string, company_id?: string |
| prodantix.reports.reply_to_comment_thread | Add a comment to a thread on a saved report. A thread whose first comment was deleted takes no replies. | project_id: string, thread_id: string, body: string, mentions?: array, company_id?: string |
| prodantix.reports.restore | Bring a deleted report back within the hour before it is purged. | project_id: string, report_id: string, company_id?: string |
| prodantix.reports.restore_version | Make an earlier version of a report its current one. | project_id: string, report_id: string, version: integer, company_id?: string |
| prodantix.reports.start_comment_thread | Start a comment thread on a saved report, or on one point of it when the anchor names the point. The body is 1 to 10,000 characters; mentions name up to 20 members of the company by their subject. | project_id: string, report_id: string, body: string, anchor?: object, mentions?: array, company_id?: string |
| prodantix.reports.update | Replace a report's query, kind or chart, recording a new version. The query is JSON in the format https://prodantix.com/en/docs/analytics describes, and the chart settings are described at https://prodantix.com/en/docs/console-analytics. | project_id: string, report_id: string, query: object | array | string | number | boolean | null, kind: string, viz: string, chart?: object | array | string | number | boolean | null, company_id?: string |
| prodantix.workflows.cancel | Cancel a running workflow. | project_id: string, run_id: string, company_id?: string |
| prodantix.workflows.create | Create a workflow from a draft. | project_id: string, name: string, draft: object, company_id?: string |
| prodantix.workflows.delete | Delete a workflow and its versions. | project_id: string, definition_id: string, company_id?: string |
| prodantix.workflows.fire | Start a run of a workflow now, with optional JSON input. | project_id: string, definition_id: string, input?: string, company_id?: string |
| prodantix.workflows.get | One workflow definition with its draft and published versions. | project_id: string, definition_id: string, company_id?: string |
| prodantix.workflows.list | A project's workflow definitions by name, at most 500 a call; pass the last definitionId as after for the next. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.workflows.publish | Publish a workflow's draft as a new version. | project_id: string, definition_id: string, company_id?: string |
| prodantix.workflows.run | One workflow run. | project_id: string, run_id: string, company_id?: string |
| prodantix.workflows.run_steps | Each step of one run with its input, output and timing, oldest first, at most 500 a call; pass the last stepId as after for the next. | project_id: string, run_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.workflows.runs | Recent runs, optionally of one workflow or with one status. | project_id: string, definition_id?: string, status?: string, limit?: integer, before?: string, before_run_id?: string, company_id?: string |
| prodantix.workflows.runs_page | A page of one workflow's runs, optionally searched. | project_id: string, definition_id: string, status?: string, query?: string, offset?: integer, limit?: integer, company_id?: string |
| prodantix.workflows.save_layout | Save where a workflow's steps sit on the canvas. | project_id: string, definition_id: string, layout: string, company_id?: string |
| prodantix.workflows.set_enabled | Turn a workflow on or off. | project_id: string, definition_id: string, enabled: boolean, company_id?: string |
| prodantix.workflows.signal | Send a named signal to a waiting run. | project_id: string, run_id: string, signal_name: string, payload?: string, company_id?: string |
| prodantix.workflows.stats | Run counts and outcomes for each of a project's workflows. | project_id: string, limit?: integer, after?: string, company_id?: string |
| prodantix.workflows.update | Replace a workflow's draft. | project_id: string, definition_id: string, draft: object, company_id?: string |
| prodantix.workflows.version_graph | A published version's step graph, as JSON. | project_id: string, version_id: string, company_id?: string |