NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Refiner connects to a Nagent workspace with an API key. Once it is connected, agents can call 10 Refiner actions, such as "Get Account Info", "Get Contact" and "Get Contacts". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Refiner, with input parameters and output schema.
REFINER_DELETE_CONTACTTool to delete a specific contact by its identifier. Provide either the user ID or email address to identify and delete the contact.
Input parameters
Your user ID that was used when the contact was created. This is the primary identifier for the contact.
The email address of the contact to delete. Can be used as an alternative to id.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_ACCOUNT_INFORetrieves Refiner account information including subscription plan, usage limits, and environment statistics. This action provides: - Current subscription plan and usage limits (MTU, MTE, MPV, MSR) - Usage counters for monthly tracked users, events, page views, and survey responses - Per-environment breakdown of usage statistics - Last updated timestamps for all usage metrics Use this when you need to check account status, monitor usage against limits, or audit environment statistics.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_CONTACTRetrieve detailed information about a specific contact using their ID, email, or UUID. Returns all stored attributes, segments, and account information.
Input parameters
Your user ID used when the contact was created.
Refiner-generated UUID of the contact.
Email address of the contact.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_CONTACTSTool to retrieve a list of contacts from your Refiner account. Use when you need to filter or paginate through contacts.
Input parameters
Page number for pagination, must be >= 1.
Filter by contact email, ID, or name.
Order contacts by this field.
Filter contacts by survey UUID.
Cursor for fetching next page in large result sets.
Number of items per page (max 1000).
Filter contacts by segment UUID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_FORMSTool to retrieve a list of forms (surveys) from your Refiner account with optional filtering and pagination. Use when you need to list surveys by state, page, or include extra info/config.
Input parameters
Which surveys to include by state. One of: all, published, drafts, archived, all_with_archived.
Page number for pagination, must be >=1.
Number of items per page (max 1000).
If True, include additional meta data (timestamps, counts, folder, page_url).
If True, include full survey configuration and elements.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_REPORTINGTool to retrieve aggregated reporting data for surveys including metrics and analytics. Use when you need survey analytics over a time range filtered by type, question identifiers, tags, forms, or segments.
Input parameters
Type of report to generate. One of 'nps', 'csat', 'ratings', 'distribution', or 'count'.
Only include data points linked to these tag UUIDs. NOTE: This parameter may not be supported by the current API version.
Only include data points from these form (survey) UUIDs. NOTE: This parameter may not be supported by the current API version.
Only include data points for users in these segment UUIDs. NOTE: This parameter may not be supported by the current API version.
ISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to end date range. Only data before this time is counted.
ISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to start date range. Only data on or after this time is counted.
Only include data points for these question identifiers. If omitted, all matching questions are included. NOTE: This parameter may not be supported by the current API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_RESPONSESTool to retrieve all survey responses from your Refiner account with optional filtering and pagination. Use after confirming survey creation to pull response data.
Input parameters
Page number for pagination. Must be >=1. Default is 1.
Search by contact user ID, response UUID, email, or name.
Which responses to include: completed, partials, or all.
Filter responses by a single survey form UUID.
Filter responses by multiple survey form UUIDs.
Cursor token for next page; use pagination.next_page_cursor.
Items per page. Default is 50; maximum is 1000.
Filter responses by a single segment UUID.
Filter responses by multiple segment UUIDs.
ISO-8601 end date (exclusive) for last_data_reception_at.
If true, include full contact attributes (API expects 1 or 0).
ISO-8601 start date (inclusive) for last_data_reception_at.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_GET_SEGMENTSTool to retrieve a list of user segments from your Refiner account. Use when you need to view or paginate segments.
Input parameters
Page number for pagination, must be >= 1.
Cursor for fetching next page in large result sets.
Number of items per page (max 1000).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_TRACK_EVENTTool to record a user event by name for a user identified via user ID or email. Use after confirming the identifier and event name.
Input parameters
Refiner user ID. Required if email is not provided.
User email address. Required if id is not provided.
Name of the event to track for the specified user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
REFINER_UPDATE_CONTACTTool to create or update a contact's attributes or account. Identifies a contact by `id` or `email` and updates their traits or account grouping. If the contact doesn't exist, it will be created automatically.
Input parameters
Your internal user ID. Required if email is not provided.
User email address. Required if id is not provided.
Nested account object for grouping users. Must include an `id` field; additional traits allowed.
Traits to update (key=trait slug). Values: string (<=255 chars), integer, or boolean. Date-time strings accepted for keys ending with `_at`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 10 Refiner actions on Nagent, including "Get Account Info", "Get Contact" and "Get Contacts". Get Account Info: Retrieves Refiner account information including subscription plan, usage limits, and environment statistics. Each action is listed on this page with its input parameters and its output.
Refiner connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.