add_dashboard_filter
ChatGPTAdd a dashboard-wide filter to a dashboard you can edit: a button in the filter bar driving a field of several insights at once. Map it to the insights with rels, or later with set_dashboard_filter_mappings.
add_dashboard_widget
ChatGPTPlace an insight (widget) you can read on a dashboard of the same team you can edit, at a position on its grid. Refused on a linked copy, which shows the insights of its source dashboard, and at a place covering another insight.
cancel_invite
ChatGPTCancel a pending invite to a team you administer: its link stops working. Find it with search_records on company_invites.
copy_widget
ChatGPTCopy an insight (widget) you can read into a new insight you own, in the same team, with its configuration and documentation, under the name given or the source's. Given a dashboard you can edit, the copy is placed on it, at the size the source has there (6 by 4 otherwise) and the first free place unless x and y are given. Change the copy with update_widget: the source is left as it is.
count_records
ChatGPTCount the Keypup records you can read matching the query search_records takes, across your teams unless the query names one (company_id_eq). With items, count the items a JSON path yields in them, and the records holding them, grouped by up to three paths within each item, e.g. the filter rules of your widgets by operator. Returns counts, never records.
create_dashboard
ChatGPTCreate an empty dashboard you own in a team, pinned in your sidebar unless pinned is false. Add insights to it with create_widget, copy_widget or add_dashboard_widget, and filters with add_dashboard_filter.
create_widget
ChatGPTCreate a widget (insight) you own in a team, given in the form get_widget returns: at least its name, visualizationType, dataset (none for a MARKDOWN or a separator, optional for a MINICARD or a LARGECARD) and the sections of its type. It starts from the type's blank template, and the parts given replace the template's; a KPI section given without dimensions has none, its value covering every record its filters keep. Given a dashboard you can edit, it is placed on it, at the first free place unless x and y are given. It is checked and its queries run before anything is saved. Given a template_id, it starts from the template get_template reads instead, and widget is optional. See the server instructions, "Changing an insight".
delete_dashboard
ChatGPTDelete a dashboard you may delete (its owner can). Its linked copies are deleted with it, which the answer names. With delete_widgets, the insights on this dashboard and on no other are deleted too, as the app offers; without, they are kept, on no dashboard. Read it first, say what will be deleted, and act only when the user has asked for it.
delete_widget
ChatGPTDelete an insight (widget) you own. It is removed from every dashboard holding it, which the answer names: to take it off one dashboard only, use remove_dashboard_widget. Read it first and act only when the user has asked for it.
disable_projects
ChatGPTDisconnect projects of a team you administer, as the app does: their data stops syncing and is removed from reports. Projects already disabled are skipped.
enable_projects
ChatGPTConnect disabled projects of a team you administer and import their data, as the app does. Projects already enabled are skipped. Refused when the team's plan does not allow that many projects. Follow the import with get_record on the import_batches record returned; you are emailed when it completes.
generate_dataset_query
ChatGPTTurn a natural-language prompt into a structured dataset query that can be executed via the query_dataset tool.
get_company_ai_instructions
ChatGPTGet the AI steering instructions (additional context provided by the company to guide AI responses) for a given company.
get_dashboard_queries
ChatGPTReturn the filters of a dashboard you can read and, in the order the dashboard shows them, its insights with the queries each runs once the dashboard filters are applied. Run each query by passing its arguments to query_dataset, where ME() refers to you. An insight that cannot be compiled, such as a card insight, comes with an error and no queries.
get_insight_queries
ChatGPTReturn the queries an insight (widget) you can read runs, compiled from its configuration, with the filters of the dashboard given as that dashboard shows it. Run each query by passing its arguments to query_dataset, where ME() refers to you. Card insights (MINICARD, LARGECARD) cannot be compiled yet.
get_record
ChatGPTRead one Keypup record you can read by id, with its related records: the id of each record it belongs to, and the search_records query listing the records that belong to it. Name the attributes you need, or a JSON path within a json_attribute, to keep the record small.
get_template
ChatGPTReturn an insight template of the library in the form get_widget returns an insight: its name, description and documentation, type, dataset, formatting and series, with metrics, dimensions and filters as formulas and rulesets, and its type's rules. It is filled with the app's default answers, such as workflow statuses, labels and commit keywords: adapt them to the team. Create it with create_widget given its template_id, or give what you read, changed, as create_widget's widget.
get_widget
ChatGPTReturn a widget (insight) you can read: its name, description and documentation, its type (visualizationType), dataset, style options (formatting) and series by what they are (mainSeries and trendSeries, report, minicardBoard, largecardFeed), with metrics, dimensions and columns as formulas, filters as rulesets and each metric's drilldown. permissions.canEdit says whether you may change it; rules says what its type takes. update_widget and create_widget take the same form. Read it before changing a widget.
invite_member
ChatGPTInvite someone to a team you administer: they receive an email to join it with the role given. Pending invites are the company_invites resource; cancel_invite cancels one.
list_companies
ChatGPTList the companies that the authenticated user belongs to.
list_dataset_fields
ChatGPTList the fields available on a given dataset (fact) for a company. Supports pagination and filtering by source (NATIVE/CUSTOM) and a regex pattern matched against the field id or alt.
list_datasets
ChatGPTList the datasets (facts) available for querying on the Viz API.
list_formula_operators
ChatGPTList the operators and functions available in custom formulas (for dimensions and metrics). Supports filtering by a regex pattern matched against the operator name, and by scope (DIMENSION/METRIC). Set verbose to true to include the full documentation for each operator (omitted by default to save tokens).
list_resources
ChatGPTList the Keypup records you can read (dashboards, widgets, companies, projects, members...) with the attributes each one can be searched on with search_records. A widget is what Keypup calls an insight, and a company a team.
pin_dashboard
ChatGPTPin a dashboard you can read in your sidebar, or unpin it with pinned false. Only your own sidebar changes.
query_dataset
ChatGPTRun a report query against a dataset (fact). Metrics, dimensions and filters are expressed as text-based formulas (see the list_dataset_fields tool to discover the available formulas).
remove_dashboard_filter
ChatGPTRemove a filter from a dashboard you can edit. Its insights fall back on their own filters.
remove_dashboard_widget
ChatGPTRemove an insight (widget) from a dashboard you can edit. The insight itself is kept, with its other dashboards.
remove_member
ChatGPTRemove a member from a team you administer: their access ends at once. What they own in the team (dashboards, insights) stays. Find the membership with search_records on user_company_rels. You cannot remove yourself, as in the app.
revoke_session
ChatGPTSign yourself out of one of your sessions (user_sessions), for a lost device. Your other sessions and your API tokens keep working.
search_records
ChatGPTSearch the Keypup records you can read, newest first, with conditions on the attributes list_resources returns and JSON paths in its json_attributes, across your teams unless the query names one (company_id_eq). Long values are truncated at value_limit characters: raise it, or read a record with get_record, for more. Name the attributes you need, or a JSON path within a json_attribute, to keep the records small.
search_templates
ChatGPTSearch the insight template library of the Keypup app: insights written by people who know the datasets, to start from rather than build one from nothing. Read one with get_template before creating from it. A template ending in -github is for teams on GitHub, whose formulas differ; the one without the suffix serves the other Git apps.
set_dashboard_filter_mappings
ChatGPTSet which field of each insight the filters of a dashboard you can edit drive, or unmap an insight with field null. Each field must exist on the insight's dataset with a type the filter can drive. Without a widget_id, the field is mapped on every insight having it. Other mappings are kept.
share_dashboard
ChatGPTShare a dashboard you may share with a member of its team, who is notified by email and gets it pinned, or with the whole team. The role "none" removes their access. You cannot give more access than you have.
track_project
ChatGPTAsk the connector of an integration of a team you administer to track a project it cannot list, such as a public repository. The project appears in the integration's projects within about 15 seconds; enable it then with enable_projects.
update_company
ChatGPTRename a team (company) you administer, or change its AI steering. Changes only the fields given.
update_dashboard
ChatGPTRename a dashboard you can edit, or change its description or its icon. Changes only the fields given. Its insights' placements are add_dashboard_widget and the like, its filters add_dashboard_filter and the like.
update_dashboard_filter
ChatGPTChange the name, operator and value, lock, visibility or allowed values of a filter of a dashboard you can edit. Changes only what is given; the type cannot change (remove the filter and add another). Mappings are set_dashboard_filter_mappings.
update_dashboard_widget
ChatGPTMove or resize an insight (widget) on the grid of a dashboard you can edit. Changes only the values given. A place covering another insight is refused.
update_membership
ChatGPTChange a member's role in a team you administer, or enable or disable their membership. Disabling ends their access to the team at once. Find the membership with search_records on user_company_rels. Your own membership cannot be changed, as in the app.
update_widget
ChatGPTChange a widget (insight) you own: its name, description, documentation and whether it shows, its type, dataset, style options and series (metrics, dimensions, LIST columns, filters, limit, sorting, colours, drilldowns), or a MARKDOWN text. Give widget in the form get_widget returns, whole or the parts to change: each part given replaces the stored one unless equal to it; the others are kept. A change to the type, dataset or series is checked and the widget's queries run before it is saved: nothing is saved on an error. See the server instructions, "Changing an insight".