NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Refiner

refiner

Refiner is a customer feedback and survey tool designed to help businesses collect and analyze user insights.

Forms & SurveysAnalyticsWeb del proveedor
Acciones
10
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool to delete a specific contact by its identifier. use after confirming the contact's id, email, or uuid.

Parámetros de entrada

  • idstring

    The unique identifier of the contact to delete.

  • uuidstring

    The Refiner-generated UUID of the contact to delete.

  • emailstring

    The email address of the contact to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Account InfoREFINER_GET_ACCOUNT_INFOAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ContactREFINER_GET_CONTACTAcción

Tool 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

  • idstring

    Your user ID used when the contact was created.

  • uuidstring

    Refiner-generated UUID of the contact.

  • emailstringemail

    Email address of the contact.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ContactsREFINER_GET_CONTACTSAcción

Tool to retrieve a list of contacts from your refiner account. use when you need to filter or paginate through contacts.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1.

  • order_bystringenum

    Order contacts by this field.

    first_seen_atlast_seen_atlast_form_submission_at
  • form_uuidstring

    Filter contacts by survey UUID.

  • page_cursorstring

    Cursor for fetching next page in large result sets.

  • page_lengthinteger

    Number of items per page (max 1000).

  • segment_uuidstring

    Filter contacts by segment UUID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get FormsREFINER_GET_FORMSAcción

Tool 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

  • liststringenum

    Which surveys to include by state. One of: all, published, drafts, archived, all_with_archived.

    allpublisheddraftsarchivedall_with_archived
  • pageinteger

    Page number for pagination, must be >=1.

  • page_lengthinteger

    Number of items per page (max 1000).

  • include_infoboolean

    If True, include additional meta data (timestamps, counts, folder, page_url).

  • include_configboolean

    If True, include full survey configuration and elements.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ReportingREFINER_GET_REPORTINGAcción

Tool 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

  • typestringObligatorioenum

    Type of report to generate. One of 'nps', 'csat', 'ratings', 'distribution', or 'count'.

    npscsatratingsdistributioncount
  • tag_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-time

    ISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to end date range. Only data before this time is counted.

  • date_range_startanydate-time

    ISO8601 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

  • npsinteger

    Calculated Net Promoter Score (only for 'nps' report).

  • suminteger

    Sum of all rating values (only for 'ratings' report).

  • csatinteger

    Calculated Customer Satisfaction Score (only for 'csat' report).

  • dataobject

    Mapping of metric key to its count. For 'nps' and 'csat', keys are fixed names; for 'ratings' and 'distribution', keys are rating values as strings.

  • countinteger

    Total count of data points (e.g., total responses).

  • errorstring

    Error if any occurred during the execution of the action

  • viewsinteger

    Number of survey views (only for 'count' report).

  • averagenumber

    Average rating value (only for 'ratings' report).

  • responsesinteger

    Number of responses (only for 'distribution' report).

  • datapointsinteger

    Number of total data points considered (only for 'distribution' report).

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • date_range_endanyObligatoriodate-time

    End of the date range for the report (ISO8601 format).

  • date_range_startanyObligatoriodate-time

    Start of the date range for the report (ISO8601 format).

Get Survey ResponsesREFINER_GET_RESPONSESAcción

Tool 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

  • pageinteger

    Page number for pagination. Must be >=1. Default is 1.

  • searchstring

    Search by contact user ID, response UUID, email, or name.

  • includestringenum

    Which responses to include: completed, partials, or all.

    completedpartialsall
  • form_uuidstring

    Filter responses by a single survey form UUID.

  • form_uuidsstring[]

    Filter responses by multiple survey form UUIDs.

  • page_cursorstring

    Cursor token for next page; use pagination.next_page_cursor.

  • page_lengthinteger

    Items per page. Default is 50; maximum is 1000.

  • segment_uuidstring

    Filter responses by a single segment UUID.

  • segment_uuidsstring[]

    Filter responses by multiple segment UUIDs.

  • date_range_endanydate-time

    ISO-8601 end date (exclusive) for last_data_reception_at.

  • with_attributesboolean

    If true, include full contact attributes (API expects 1 or 0).

  • date_range_startanydate-time

    ISO-8601 start date (inclusive) for last_data_reception_at.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SegmentsREFINER_GET_SEGMENTSAcción

Tool to retrieve a list of user segments from your refiner account. use when you need to view or paginate segments.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1.

  • page_cursorstring

    Cursor for fetching next page in large result sets.

  • page_lengthinteger

    Number of items per page (max 1000).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Track EventREFINER_TRACK_EVENTAcción

Tool 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

  • idstring

    Refiner user ID. Required if email is not provided.

  • emailstringemail

    User email address. Required if id is not provided.

  • eventstringObligatorio

    Name of the event to track for the specified user.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ContactREFINER_UPDATE_CONTACTAcción

Tool 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

  • idstring

    Your internal user ID. Required if email is not provided.

  • emailstringemail

    User email address. Required if id is not provided.

  • accountobject

    Nested account object for grouping users. Must include an `id` field; additional traits allowed.

  • attributesobject

    Traits 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not