> For the complete documentation index, see [llms.txt](https://ask.birdie.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ask.birdie.ai/integrations-and-data-ingestion/how-to-integrate-with/survicate.md).
# Survicate
#### Overview
Birdie’s Salesforce connector lets you easily import survey responses from your Survicate account. This API enables Birdie to fetch survey responses, list surveys and questions. See the Survicate [Help center](https://help.survicate.com/) for more information about it's functionalities and usability.
#### Requirements
* Your company's Survicate account must be subscribed to a plan that includes access to the data export API.
* A data exports API Key.
The API key can be found in the Survicate panel, specifically under the "Surveys Settings" tab.
This will open the "General" section for "Survey settings" and from there you can navigate to the "Access Keys" section.
The API key should be used to setup the integration.
> Caution: The API key can be updated with the "Generate new" button and, if so, Birdie's connection with the API will be lost until the change is reported by the company and the new one sent.
#### Share Connection Details with Birdie
To configure the integration, securely provide Birdie with the following information:
```json
{
"connection_details": {
"api_key": "your-survicate-data-export-api-key"
}
}
```
| Section | Field | Required | Description |
| -------------------- | --------- | -------- | ------------------------------------------------------------------------------- |
| `connection_details` | `api_key` | Yes | Survicate Data Export API key (found in Settings > Organization > Access Keys). |
[Share credentials securely](https://ask.birdie.ai/integrations-and-data-ingestion/securely-sharing-credentials-for-data-integration) with the Birdie team. Never send credentials via email or unencrypted channels.
#### Survicate Structure
Detailed information about the structure of [surveys](https://developers.survicate.com/data-export/survey/), [survey responses](https://developers.survicate.com/data-export/response/) and [respondents](https://developers.survicate.com/data-export/respondent/) can be found within the Data Export API documentation.\
Each question within a survey can have a different type. Survicate has multiple question types, but for the integration to work, the surveys must have at least one (and only one) question of type NPS or CSAT, and any number of questions of other types.\
A NPS type question can be created by simply choosing NPS from Survicate's type list.
Setting up a CSAT type question is less straightforward: CSAT will be a specific subsetting of a Rating type question.
Birdie's connector will transform these entities into a feedback. A feedback will have:
* a text field which is a compilation of the questions and answers for a specific survey response
* the name of the survey to which the response belongs
* the kind of the response (NPS or CSAT)
* the rating of the response
* the date the survey was answered by the user
For example, should Birdie want to evaluate it's clients feedbacks with the survey:\
A feedback built from a survey response for this survey might look something like:
```
{
"text": "How satisfied are you with Birdie?\ncsat: 5 (Satisfied)\n\nWhat more features would you like from Birdie?\nIt would be useful if Birdie could import Smiley scale type questions\n\nHow would you rate Birdie's usefulness to you?\nrating: 4",
"kind": "csat",
"rating": "5",
"title": "survey 01",
"posted_at": "2024-07-01T10:30:00Z",
"additional_fields": {
"How satisfied are you with Birdie?": 5,
"What more features would you like from Birdie?": "It would be useful if Birdie could import Smiley scale type question",
"How would you rate Birdie's usefulness to you?": 4
}
}
```
#### Custom Fields
All the additional data provided by Survicate's Data Export API that doesn't fit into the previous schema can be imported by Birdie as "additional fields". Additional fields can be used to set up custom fields, which enables text search and filtering within these fields.\
\
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://ask.birdie.ai/integrations-and-data-ingestion/how-to-integrate-with/survicate.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.