Refiner
refinerRefiner is a customer feedback and survey tool designed to help businesses collect and analyze user insights.
Acciones disponibles (10)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Delete ContactREFINER_DELETE_CONTACTAcciónTool to delete a specific contact by its identifier. use after confirming the contact's id, email, or uuid.
REFINER_DELETE_CONTACTAcciónTool to delete a specific contact by its identifier. use after confirming the contact's id, email, or uuid.
Parámetros de entrada
idstringThe unique identifier of the contact to delete.
uuidstringThe Refiner-generated UUID of the contact to delete.
emailstringThe email address of the contact to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Account InfoREFINER_GET_ACCOUNT_INFOAcciónTool to fetch refiner account subscription and environment usage details. use when you need to audit your current plan and usage.
REFINER_GET_ACCOUNT_INFOAcciónTool to fetch refiner account subscription and environment usage details. use when you need to audit your current plan and usage.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactREFINER_GET_CONTACTAcciónTool to retrieve details of a specific contact by its id. use when you need all stored traits for a known user.
REFINER_GET_CONTACTAcciónTool to retrieve details of a specific contact by its id. use when you need all stored traits for a known user.
Parámetros de entrada
idstringYour user ID used when the contact was created.
uuidstringRefiner-generated UUID of the contact.
emailstringemailEmail address of the contact.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactsREFINER_GET_CONTACTSAcciónTool to retrieve a list of contacts from your refiner account. use when you need to filter or paginate through contacts.
REFINER_GET_CONTACTSAcciónTool to retrieve a list of contacts from your refiner account. use when you need to filter or paginate through contacts.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1.
order_bystringenumOrder contacts by this field.
first_seen_atlast_seen_atlast_form_submission_atform_uuidstringFilter contacts by survey UUID.
page_cursorstringCursor for fetching next page in large result sets.
page_lengthintegerNumber of items per page (max 1000).
segment_uuidstringFilter contacts by segment UUID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get FormsREFINER_GET_FORMSAcciónTool 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.
REFINER_GET_FORMSAcciónTool 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.
Parámetros de entrada
liststringenumWhich surveys to include by state. One of: all, published, drafts, archived, all_with_archived.
allpublisheddraftsarchivedall_with_archivedpageintegerPage number for pagination, must be >=1.
page_lengthintegerNumber of items per page (max 1000).
include_infobooleanIf True, include additional meta data (timestamps, counts, folder, page_url).
include_configbooleanIf True, include full survey configuration and elements.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ReportingREFINER_GET_REPORTINGAcciónTool 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.
REFINER_GET_REPORTINGAcciónTool 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.
Parámetros de entrada
typestringObligatorioenumType of report to generate. One of 'nps', 'csat', 'ratings', 'distribution', or 'count'.
npscsatratingsdistributioncounttag_uuidsstring[]Only include data points linked to these tag UUIDs.
form_uuidsstring[]Only include data points from these form (survey) UUIDs.
segment_uuidsstring[]Only include data points for users in these segment UUIDs.
date_range_endanydate-timeISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to end date range. Only data before this time is counted.
date_range_startanydate-timeISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to start date range. Only data on or after this time is counted.
question_identifiersstring[]Only include data points for these question identifiers. If omitted, all matching questions are included.
Parámetros de salida
npsintegerCalculated Net Promoter Score (only for 'nps' report).
sumintegerSum of all rating values (only for 'ratings' report).
csatintegerCalculated Customer Satisfaction Score (only for 'csat' report).
dataobjectMapping of metric key to its count. For 'nps' and 'csat', keys are fixed names; for 'ratings' and 'distribution', keys are rating values as strings.
countintegerTotal count of data points (e.g., total responses).
errorstringError if any occurred during the execution of the action
viewsintegerNumber of survey views (only for 'count' report).
averagenumberAverage rating value (only for 'ratings' report).
responsesintegerNumber of responses (only for 'distribution' report).
datapointsintegerNumber of total data points considered (only for 'distribution' report).
successfulbooleanObligatorioWhether or not the action execution was successful or not
date_range_endanyObligatoriodate-timeEnd of the date range for the report (ISO8601 format).
date_range_startanyObligatoriodate-timeStart of the date range for the report (ISO8601 format).
Get Survey ResponsesREFINER_GET_RESPONSESAcciónTool to retrieve all survey responses from your refiner account with optional filtering and pagination. use after confirming survey creation to pull response data.
REFINER_GET_RESPONSESAcciónTool to retrieve all survey responses from your refiner account with optional filtering and pagination. use after confirming survey creation to pull response data.
Parámetros de entrada
pageintegerPage number for pagination. Must be >=1. Default is 1.
searchstringSearch by contact user ID, response UUID, email, or name.
includestringenumWhich responses to include: completed, partials, or all.
completedpartialsallform_uuidstringFilter responses by a single survey form UUID.
form_uuidsstring[]Filter responses by multiple survey form UUIDs.
page_cursorstringCursor token for next page; use pagination.next_page_cursor.
page_lengthintegerItems per page. Default is 50; maximum is 1000.
segment_uuidstringFilter responses by a single segment UUID.
segment_uuidsstring[]Filter responses by multiple segment UUIDs.
date_range_endanydate-timeISO-8601 end date (exclusive) for last_data_reception_at.
with_attributesbooleanIf true, include full contact attributes (API expects 1 or 0).
date_range_startanydate-timeISO-8601 start date (inclusive) for last_data_reception_at.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SegmentsREFINER_GET_SEGMENTSAcciónTool to retrieve a list of user segments from your refiner account. use when you need to view or paginate segments.
REFINER_GET_SEGMENTSAcciónTool to retrieve a list of user segments from your refiner account. use when you need to view or paginate segments.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1.
page_cursorstringCursor for fetching next page in large result sets.
page_lengthintegerNumber of items per page (max 1000).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Track EventREFINER_TRACK_EVENTAcciónTool to record a user event by name for a user identified via user id or email. use after confirming the identifier and event name.
REFINER_TRACK_EVENTAcciónTool to record a user event by name for a user identified via user id or email. use after confirming the identifier and event name.
Parámetros de entrada
idstringRefiner user ID. Required if email is not provided.
emailstringemailUser email address. Required if id is not provided.
eventstringObligatorioName of the event to track for the specified user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ContactREFINER_UPDATE_CONTACTAcciónTool to update an existing contact's attributes or account. use when you have a contact `id` or `email` and want to modify traits or grouping.
REFINER_UPDATE_CONTACTAcciónTool to update an existing contact's attributes or account. use when you have a contact `id` or `email` and want to modify traits or grouping.
Parámetros de entrada
idstringYour internal user ID. Required if email is not provided.
emailstringemailUser email address. Required if id is not provided.
accountobjectNested account object for grouping users. Must include an `id` field; additional traits allowed.
attributesobjectTraits to update (key=trait slug). Values: string (<=255 chars), integer, or boolean. Date-time strings accepted for keys ending with `_at`.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not