Wootric

https://docs.wootric.com/
Admin
Wootric is a customer feedback platform that enables companies to collect Net Promoter Score (NPS),...
Tokens:89,922
Snippets:628
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Onboarding Error Example

Source: https://docs.wootric.com/cxi

This example demonstrates the `424 Failed Dependency` error received when attempting to use the API before completing the onboarding flow.

```APIDOC
## Onboarding Error Example

### Description
An example of the error response when the onboarding flow has not been completed.

### Method
`GET`

### Endpoint
`$AI_SERVER/v1/imports`

### Headers
- **Authorization** (string) - Required - `Bearer myaccesstoken`

### Response
#### Error Response (424 Failed Dependency)
- **message** (string) - Indicates that the onboarding flow needs to be completed.

#### Response Example
```http
HTTP/1.1 424 Failed Dependency
...
{"message":"Please complete the onboarding flow first."}
```
```

--------------------------------

### Installing iOS SDK with Carthage

Source: https://docs.wootric.com/ios

Instructions for installing the Wootric iOS SDK using Carthage, including Cartfile configuration and update commands.

```APIDOC
## Installing iOS SDK
### Carthage

**1. Install Carthage**
If you haven’t already, install the latest version of Carthage.

**2. Cartfile**
Add `github "Wootric/WootricSDK-iOS"` to your Cartfile, and follow the Carthage installation instructions.

**3. Update SDK**
In the future, to update to the latest version of the SDK, run `carthage update --platform ios`.
```

--------------------------------

### Installing iOS SDK with Dynamic Framework

Source: https://docs.wootric.com/ios

Instructions for installing the Wootric iOS SDK as a dynamic framework, compatible with iOS 8 and above.

```APIDOC
## Installing iOS SDK
### Dynamic Framework
Note: This is only compatible with iOS 8 and above.

**1. Download SDK**
Head to our GitHub releases page and download and unzip WootricSDK.framework

**2. Add the framework to your project**
Drag WootricSDK.framework to the “Embedded Binaries” section of your Xcode project’s “General” settings. Make sure to select “Copy items if needed”
```

--------------------------------

### Update Onboarding Response Example

Source: https://docs.wootric.com/cxi

Example JSON response after attempting to update the onboarding status. Note that 'onboarded' remains false until the process is fully complete.

```json
{
  "onboarded": false,
  "mode": "full",
  "product_category_id": 9,
  "product_categories": [
    {
      "id": 1,
      "name": "General"
    },
    {
      "id": 2,
      "name": "SaaS DevOps"
    },
    {
      "id": 3,
      "name": "SaaS Anc"
    },
    {
      "id": 4,
      "name": "SaaS IDC"
    },
    {
      "id": 5,
      "name": "SaaS Education CL"
    },
    {
      "id": 6,
      "name": "SaaS GD"
    },
    {
      "id": 7,
      "name": "SaaS Social Media"
    },
    {
      "id": 15,
      "name": "Politicians Review"
    },
    {
      "id": 8,
      "name": "SaaS Social Media HS"
    },
    {
      "id": 9,
      "name": "E-Commerce"
    },
    {
      "id": 10,
      "name": "E-Commerce-WGAC"
    },
    {
      "id": 11,
      "name": "Employee Reviews"
    },
    {
      "id": 12,
      "name": "Online Food Delivery"
    },
    {
      "id": 13,
      "name": "Support Case Feedback"
    },
    {
      "id": 14,
      "name": "SaaS RC"
    }
  ],
  "tags": [
    {
      "id": 90,
      "mode": "smart",
      "name": "RETURNS",
      "response_ids": []
    },
    {
      "id": 91,
      "mode": "smart",
      "name": "SHIPPING_PACKAGING",
      "response_ids": []
    },
    ...
    {
      "id": 89,
      "mode": "smart",
      "name": "PRODUCT_QUALITY",
      "response_ids": []
    }
  ],
  "project": {
    "name": null,
    "responses": []
  }
}
```

--------------------------------

### Custom Thank You Link Example

Source: https://docs.wootric.com/javascript

This example demonstrates setting a default thank you link text and URL, along with specific overrides for promoters and detractors. It shows how to configure `thankYouLinks` and `thankYouLinksList` for targeted user experiences.

```javascript
var Wootric = {
  thankYouLinks: {
    thank_you_link_text: 'Thank you text for all scores!',
    thank_you_link_url: 'http://example.com',
    thank_you_link_text_list: {
      promoter_thank_you_link_text: 'Promoter thank you text'
    },
    thank_you_link_url_list: {
      detractor_thank_you_link_url: 'http://detractor.com'
    }
  }
};
```

--------------------------------

### Installing iOS SDK with Cocoapods

Source: https://docs.wootric.com/ios

Instructions for installing the Wootric iOS SDK using Cocoapods, including commands and Podfile configuration.

```APIDOC
## Installing iOS SDK
### Using Cocoapods

**1. Install CocoaPods**
If you don’t have Cocoapods already, you can install it by typing `$ gem install cocoapods` in your terminal

**2. Podfile**
Create a `Podfile` and add `pod 'WootricSDK'`. This will download and install the latest version of the SDK. If you want to you can specify which version of the SDK by doing something like this `pod 'WootricSDK', '0.5.6'`. For more information about creating this file, please refer to Cocoapod’s Podfile Guide.

**3. Install WootricSDK**
On your terminal, and inside your project’s directory, run `$ pod install`. Cocoapods will download all dependencies specified in your `Podfile`. From now on, you should use the `.xcworkspace` file instead of the `.xcodeproject` file.
```

--------------------------------

### Get Onboarding Status

Source: https://docs.wootric.com/cxi

Retrieve the current onboarding status of your account. This is useful for checking if initial setup is complete. Requires an access token for authorization.

```curl
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/onboarding" | jq
```

--------------------------------

### Install Wootric iOS SDK with Cocoapods

Source: https://docs.wootric.com/ios

Use this method to install the Wootric SDK if you are using Cocoapods. Ensure Cocoapods is installed and add the SDK to your Podfile.

```bash
$ gem install cocoapods
```

```ruby
target 'YourProject' do
  pod 'WootricSDK'
end
```

```bash
$ pod install
```

--------------------------------

### Custom Thank You Messages and Links Example

Source: https://docs.wootric.com/javascript

This example configures both custom thank you messages and links, including score-specific overrides. It illustrates how to use `thankYouMessages` and `thankYouLinks` with their respective list variants for detailed customization.

```javascript
var Wootric = {
  thankYouMessages: {
    thank_you_setup: 'Request for action for all scores',
    thank_you_setup_list: {
      promoter_thank_you_setup: 'Promoter request for action'
    }
  },
  thankYouLinks: {
    thank_you_link_text: 'Thank you text for all scores!',
    thank_you_link_url: 'http://example.com',
    thank_you_link_text_list: {
      promoter_thank_you_link_text: 'Promoter thank you text'
    },
    thank_you_link_url_list: {
      detractor_thank_you_link_url: 'http://detractor.com'
    }
  }
};
```

--------------------------------

### Get All Projects

Source: https://docs.wootric.com/cxi

Retrieves a list of all projects in your account. Replace `myaccesstoken` with your actual token.

```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/projects" | jq
```

--------------------------------

### Example Decline Object JSON

Source: https://docs.wootric.com/api

This is an example of the JSON response structure when retrieving all declines.

```json
[
    {
        "id": 1,
        "end_user_id": 1,
        "survey_id": 10,
        "ip_address": "127.0.0.1",
        "origin_url": "https://wootric.com",
        "created_at": "2016-12-16 14:20:43 -0800",
        "updated_at": "2016-12-16 14:20:43 -0800",
        "end_user": {
            "properties": {
                "persona": "Individual",
                "pricing_plan": "Small Business",
                "product_plan": "Mobile",
                "purchase_date": 1473177881,
                "revenue_amount": 5000
            }
        }
    },
    {
        "id": 2,
        "end_user_id": 2,
        "survey_id": 11,
        "ip_address": "127.0.0.1",
        "origin_url": "https://wootric.com",
        "created_at": "2016-12-16 14:21:10 -0800",
        "updated_at": "2016-12-16 14:21:10 -0800",
        "end_user": {
            "properties": {
                "persona": "Business User",
                "pricing_plan": "Small Business",
                "product_plan": "Mobile",
                "purchase_date": 1473177881,
                "revenue_amount": 5000
            }
        }
    }
]
```

--------------------------------

### Install Segment-Wootric with Cocoapods

Source: https://docs.wootric.com/ios

Add this line to your Podfile to install the Segment-Wootric integration. This allows Wootric to work with Segment for event tracking and user management.

```ruby
pod "Segment-Wootric"

```

--------------------------------

### Authentication with Password Grant

Source: https://docs.wootric.com/cxi

This example shows how to obtain an access token using the `password` grant type with your account email and password.

```APIDOC
## Authentication with Password Grant

### Description
Obtain an access token using the `password` grant type.

### Method
`POST`

### Endpoint
`/oauth/token`

### Parameters
#### Form Parameters
- **grant_type** (string) - Required - `password`
- **username** (string) - Required - Your account email address
- **password** (string) - Required - Your account password

### Request Example
```bash
curl -i https://api.wootric.com/oauth/token \
     -F grant_type=password \
     -F username=<youremailaddress> \
     -F password=<yourpassword>
```

### Response
#### Success Response (200)
- **access_token** (string) - The obtained access token.
- **token_type** (string) - The type of token, usually `bearer`.
- **expires_in** (integer) - The token's expiration time in seconds.
- **refresh_token** (string) - A token to refresh the access token.
- **scope** (string) - The scope of the token.

#### Response Example
```json
{
  "access_token":"<youraccesstoken>",
  "token_type":"bearer",
  "expires_in":7200,
  "refresh_token":"<yourrefreshtoken>",
  "scope":"public"
}
```
```

--------------------------------

### Onboarded Account Status Response

Source: https://docs.wootric.com/cxi

Example JSON response for an account that has completed onboarding. Indicates the 'onboarded' status is true.

```json
{
  "onboarded": true,
  "mode": "full"
}
```

--------------------------------

### Get Projects

Source: https://docs.wootric.com/cxi

Retrieves a list of all projects associated with the authenticated account.

```APIDOC
## GET /v1/projects

### Description
This endpoint gets all projects in your account.

### Method
GET

### Endpoint
https://cxi-api.wootric.com/v1/projects

### Response
#### Success Response (200)
- **id** (integer) - The ID of the project.
- **name** (string) - The name of the project.
- **response_count** (integer) - The number of responses in this project.
- **created_at** (integer) - The project's creation date as a Unix Timestamp.

#### Response Example
```json
[
  {
    "id": 7,
    "name": "Enterprise",
    "response_count": 0,
    "created_at": 1610774054
  }
]
```
```

--------------------------------

### API Request with Authorization Header

Source: https://docs.wootric.com/cxi

This example shows how to include the access token in the `Authorization` header for API requests.

```APIDOC
## API Request with Authorization Header

### Description
Include the access token in the `Authorization` header for all API requests.

### Method
`GET` (example)

### Endpoint
`https://cxi-api.wootric.com/v1/imports` (example)

### Headers
- **Authorization** (string) - Required - `Bearer <youraccesstoken>`

### Request Example
```bash
curl -X GET -H "Authorization: Bearer <youraccesstoken>" https://cxi-api.wootric.com/v1/imports
```
```

--------------------------------

### Not Onboarded Account Status Response

Source: https://docs.wootric.com/cxi

Example JSON response for an account that has not yet completed onboarding. Includes details about product categories and tags.

```json
{
  "onboarded": false,
  "mode": "full",
  "product_category_id": null,
  "product_categories": [
    {
      "id": 1,
      "name": "General"
    },
    {
      "id": 2,
      "name": "SaaS DevOps"
    },
    {
      "id": 3,
      "name": "SaaS Anc"
    },
    {
      "id": 4,
      "name": "SaaS IDC"
    },
    {
      "id": 5,
      "name": "SaaS Education CL"
    },
    {
      "id": 6,
      "name": "SaaS GD"
    },
    {
      "id": 7,
      "name": "SaaS Social Media"
    },
    {
      "id": 15,
      "name": "Politicians Review"
    },
    {
      "id": 8,
      "name": "SaaS Social Media HS"
    },
    {
      "id": 9,
      "name": "E-Commerce"
    },
    {
      "id": 10,
      "name": "E-Commerce-WGAC"
    },
    {
      "id": 11,
      "name": "Employee Reviews"
    },
    {
      "id": 12,
      "name": "Online Food Delivery"
    },
    {
      "id": 13,
      "name": "Support Case Feedback"
    },
    {
      "id": 14,
      "name": "SaaS RC"
    }
  ],
  "tags": []
}
```

--------------------------------

### Get Survey Templates

Source: https://docs.wootric.com/api

Retrieve information about all survey templates, including their IDs, names, and supported languages.

```bash
curl -H "Authorization: Bearer myaccesstoken" "https://api.wootric.com/v1/survey_templates?access_token=account_access_token"
```

--------------------------------

### Get All Imports

Source: https://docs.wootric.com/cxi

Retrieve a list of all imports in your account. This endpoint supports pagination with optional 'page' and 'per_page' URL parameters.

```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/imports" | jq

```

--------------------------------

### Get All Tags

Source: https://docs.wootric.com/cxi

Retrieve all tags associated with your account. This command fetches tags and formats the output using jq for readability.

```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/tags" | jq

```

--------------------------------

### API Request with Authorization Header

Source: https://docs.wootric.com/api

This example demonstrates how to include your access token in the Authorization header for API requests.

```curl
curl -H "Authorization: Bearer <youraccesstoken>" https://api.wootric.com/v1/end_users
```

--------------------------------

### Get Onboarding Status

Source: https://docs.wootric.com/cxi

Retrieves the current onboarding status of your account. This endpoint is useful for checking if your account has been fully set up and onboarded.

```APIDOC
## Get Onboarding status

### Description
This endpoint will give you the onboarding status of your account.

### Method
GET

### Endpoint
`https://cxi-api.wootric.com/v1/onboarding`

### Request Example
```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/onboarding" | jq
```

### Response
#### Success Response (200)
- **onboarded** (boolean) - Indicates if the account is onboarded.
- **mode** (string) - The current onboarding mode.
- **product_category_id** (null or integer) - The ID of the selected product category, if applicable.
- **product_categories** (array) - A list of available product categories.
- **tags** (array) - A list of associated tags.

#### Response Example (Onboarded)
```json
{
  "onboarded": true,
  "mode": "full"
}
```

#### Response Example (Not Onboarded)
```json
{
  "onboarded": false,
  "mode": "full",
  "product_category_id": null,
  "product_categories": [
    {
      "id": 1,
      "name": "General"
    },
    {
      "id": 2,
      "name": "SaaS DevOps"
    }
  ],
  "tags": []
}
```
```

--------------------------------

### Onboard Account with Project and Import Details

Source: https://docs.wootric.com/cxi

Use this endpoint to onboard an account and set project and import details. Ensure you have a valid Bearer token for authorization.

```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X PUT "https://cxi-api.wootric.com/v1/onboarding" \
  -F project[name]=Enterprise \
  -F import[name]=important.csv \
  -F import[source]="Survey Monkey" \
  -F import[metric_type]=NPS \
  | jq
```

--------------------------------

### Initialize Wootric SDK (Swift)

Source: https://docs.wootric.com/ios

Configure the Wootric SDK with your Client ID and Account Token. Set end-user details and optionally force survey display for testing.

```swift
Wootric.configureWithClientID(<YOUR_CLIENT_ID>, accountToken: <YOUR_ACCOUNT_TOKEN>)

// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
Wootric.setEndUserEmail("nps@example.com")
// TODO: The current logged in user's sign-up date as a Unix timestamp.
Wootric.setEndUserCreatedAt(1234567890)

// Use only for testing
Wootric.forceSurvey(true)

Wootric.showSurveyInViewController(<YOUR_VIEW_CONTROLLER>)

```

```swift
Wootric.configure(withClientID: <YOUR_CLIENT_ID> , accountToken:<YOUR_ACCOUNT_TOKEN>)

// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
Wootric.setEndUserEmail("nps@example.com")
// TODO: The current logged in user's sign-up date as a Unix timestamp.
Wootric.setEndUserCreatedAt(1234567890)

// Use only for testing
Wootric.forceSurvey(true)

Wootric.showSurvey(in: <YOUR_VIEW_CONTROLLER>)

```

--------------------------------

### Install Wootric Javascript SDK

Source: https://docs.wootric.com/javascript

Add this script to your HTML to pull the Wootric SDK and initialize it with your account token and user information. Ensure 'email' and 'created_at' are set for user identification and 'account_token' is unique to your account.

```html
<script type="text/javascript" src="https://cdn.wootric.com/wootric-sdk.js"></script>
<!-- begin Wootric code -->
<script type="text/javascript">
  window.wootricSettings = {
    email:'nps@example.com',// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
    created_at: 1234567890, // TODO: The current logged in user's sign-up date as a Unix timestamp.
    account_token: 'NPS-xxxxxxx'
  };

  // Request a survey
  window.wootric('run');
</script>
...//The rest of the widget...
<!-- end Wootric code -->
```

--------------------------------

### Initialize Wootric SDK (Objective-C)

Source: https://docs.wootric.com/ios

Configure the Wootric SDK with your Client ID and Account Token. Set end-user details and optionally force survey display for testing.

```objective-c
#import <WootricSDK/WootricSDK.h>

// Inside your method
[Wootric configureWithClientID:<YOUR_CLIENT_ID> accountToken:<YOUR_ACCOUNT_TOKEN>];

// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
[Wootric setEndUserEmail:@"nps@example.com"];
// TODO: The current logged in user's sign-up date as a Unix timestamp.
[Wootric setEndUserCreatedAt:@1234567890];

// Use only for testing
[Wootric forceSurvey:YES];

[Wootric showSurveyInViewController:<YOUR_VIEW_CONTROLLER>];

```

--------------------------------

### Get Specific Import

Source: https://docs.wootric.com/cxi

Retrieve detailed information about a specific import using its ID. This endpoint provides more comprehensive data than the 'Get All Imports' endpoint.

```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/imports/6" | jq

```

--------------------------------

### Initialize Wootric SDK and Show Survey

Source: https://docs.wootric.com/android

Initialize the Wootric SDK with your client ID and account token, set user properties, and trigger the survey. Use `setSurveyImmediately(true)` for testing purposes.

```java
import com.wootric.androidsdk.Wootric;

// Inside your method
Wootric wootric = Wootric.init(this, <YOUR_CLIENT_ID>, <YOUR_ACCOUNT_TOKEN>);

// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
wootric.setEndUserEmail("nps@example.com");
// TODO: The current logged in user's sign-up date as a Unix timestamp.
wootric.setEndUserCreatedAt(1234567890);

// Use only for testing
wootric.setSurveyImmediately(true);

wootric.survey();
```

--------------------------------

### Initialize Wootric SDK

Source: https://docs.wootric.com/ios

Configure the Wootric SDK with your Client ID and Account Token. Set end-user details and optionally force survey display for testing.

```APIDOC
## Initialize Wootric SDK

### Description
Configure the Wootric SDK with your Client ID and Account Token. Set end-user details and optionally force survey display for testing.

### Method
Objective-C
```objectivec
#import <WootricSDK/WootricSDK.h>

// Inside your method
[Wootric configureWithClientID:@"<YOUR_CLIENT_ID>" accountToken:@"<YOUR_ACCOUNT_TOKEN>"];

// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
[Wootric setEndUserEmail:@"nps@example.com"];
// TODO: The current logged in user's sign-up date as a Unix timestamp.
[Wootric setEndUserCreatedAt:@1234567890];

// Use only for testing
[Wootric forceSurvey:YES];

[Wootric showSurveyInViewController:<YOUR_VIEW_CONTROLLER>];
```

### Method
Swift
```swift
import WootricSDK

// Inside your method
Wootric.configure(withClientID: "<YOUR_CLIENT_ID>", accountToken: "<YOUR_ACCOUNT_TOKEN>")

// TODO: Required to uniquely identify a user. Email is recommended but this can be any unique identifier.
Wootric.setEndUserEmail("nps@example.com")
// TODO: The current logged in user's sign-up date as a Unix timestamp.
Wootric.setEndUserCreatedAt(1234567890)

// Use only for testing
Wootric.forceSurvey(true)

Wootric.showSurvey(in: <YOUR_VIEW_CONTROLLER>)
```
```

--------------------------------

### Identify User with Segment (Specific Example)

Source: https://docs.wootric.com/segment

A specific example of an `identify` call using Segment, including email, creation date, and language. This data is used by InMoment to check eligibility for survey responses.

```javascript
analytics.identify('userId123', {
  email: 'hello@example.com',
  createdAt: '2018-08-03T15:28:46.493Z',
  language: 'EN'
});
```

--------------------------------

### Initialize Segment with Wootric Integration (Swift)

Source: https://docs.wootric.com/ios

This Swift code snippet demonstrates how to set up the Segment SDK with the Wootric integration. Remember to import the necessary library.

```swift
let config = SEGAnalyticsConfiguration.init(writeKey: "YOUR_WRITE_KEY")

let wootricFactory = WTRWootricIntegrationFactory.instance() as! WTRWootricIntegrationFactory
config.use(wootricFactory)
SEGAnalytics.setupWithConfiguration(config)

WTRWootricIntegration.showSurveyInViewController(self)

```

```swift
let config = SEGAnalyticsConfiguration.init(writeKey: "1232135234124123")

let wootricFactory = WTRWootricIntegrationFactory.instance() as! WTRWootricIntegrationFactory
config?.use(wootricFactory)
SEGAnalytics.setup(with: config)

WTRWootricIntegration.showSurvey(in: self)

```

--------------------------------

### Get All Segments

Source: https://docs.wootric.com/api

Retrieves all segments associated with an account.

```APIDOC
## GET /v1/segments

### Description
Retrieves all segments for an account.

### Method
GET

### Endpoint
https://api.wootric.com/v1/segments

### Response
#### Success Response (200)
- **name** (string) - Name of the segment.
- **data_type** (string) - One of `string`, `date` or `integer` representing the segment data type.
- **created_at** (datetime) - Datetime representation of when the segment was created.

### Response Example
[
  {
    "name": "persona",
    "data_type": "string",
    "created_at": "2017-02-01 12:12:50 -0800"
  },
  {
    "name": "pricing_plan",
    "data_type": "string",
    "created_at": "2017-02-01 12:12:50 -0800"
  }
]
```

--------------------------------

### Initialize and Run Wootric Survey

Source: https://docs.wootric.com/javascript

Configure and launch the Wootric survey using the `WootricSurvey.run()` method or the global `wootric('run')` function. Ensure the `account_token` is correctly set.

```javascript
var wootricSettings = {
    account_token: 'NPS-XXXXXXX'
}

//run
WootricSurvey.run(wootricSettings); OR wootric('run')
```

--------------------------------

### Get Survey Templates

Source: https://docs.wootric.com/api

Retrieves information about all available Survey Templates.

```APIDOC
## GET /v1/survey_templates

### Description
Retrieves information about all your Survey Templates.

### Method
GET

### Endpoint
https://api.wootric.com/v1/survey_templates

### Response
#### Success Response (200)
- **default_survey_template_id** (integer) - The ID of the default survey template.
- **survey_templates** (array) - An array of survey template objects.
  - **id** (integer) - The ID of the survey template.
  - **name** (string) - The name of the survey template.
  - **default_language** (string) - The default language code for the survey template.
  - **languages** (array) - An array of supported language objects.
    - **code** (string) - The language code.
    - **name** (string) - The name of the language.
  - **non_configured_language_count** (integer) - The number of languages not yet configured.
  - **custom_samplings** (array) - An array of custom sampling configurations.

### Response Example
{
  "default_survey_template_id": XXXX,
  "survey_templates": [
    {
      "id": XXXX,
      "name": "Your default NPS survey",
      "default_language": "en",
      "languages": [
        {"code":"en","name":"English"},
        {"code":"es","name":"Spanish"}
      ],
      "non_configured_language_count":1,
      "custom_samplings":[]
    }
  ]
}
```

--------------------------------

### Authentication with Client Credentials Grant

Source: https://docs.wootric.com/cxi

This example demonstrates how to obtain an access token using the `client_credentials` grant type with your application's client ID and secret.

```APIDOC
## Authentication with Client Credentials Grant

### Description
Obtain an access token using the `client_credentials` grant type.

### Method
`POST`

### Endpoint
`/oauth/token`

### Parameters
#### Form Parameters
- **grant_type** (string) - Required - `client_credentials`
- **client_id** (string) - Required - Your application's client ID
- **client_secret** (string) - Required - Your application's client secret

### Request Example
```bash
curl -X POST https://api.wootric.com/oauth/token \
     -F grant_type=client_credentials \
     -F client_id=<yourclientid> \
     -F client_secret=<yourclientsecret>
```

### Response
#### Success Response (200)
- **access_token** (string) - The obtained access token.
- **token_type** (string) - The type of token, usually `bearer`.
- **expires_in** (integer) - The token's expiration time in seconds.
- **scope** (string) - The scope of the token.

#### Response Example
```json
{
  "access_token":"<youraccesstoken>",
  "token_type":"bearer",
  "expires_in":7200,
  "scope":"public"
}
```
```

--------------------------------

### Get Responses

Source: https://docs.wootric.com/cxi

Retrieves all responses in your account. Supports pagination and filtering.

```APIDOC
## Get Responses

### Description
This endpoint gets all responses in your account.

### Method
GET

### Endpoint
https://cxi-api.wootric.com/v1/responses

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Number of returned page, max 30
- **per_page** (integer) - Optional - Number of records returned on each page, max 50
- **sort_order** (string) - Optional - Sort responses by `feedback_date` in ascending or descending order
- **include_hidden** (boolean) - Optional - Include responses without feedback (score only responses)

### Request Example
```bash
curl -s -H "Authorization: Bearer myaccesstoken" -X GET "https://cxi-api.wootric.com/v1/responses" | jq
```

### Response
#### Success Response (200)
- **total_count** (integer) - The total number of responses.
- **items** (array) - An array of Response objects.

Response Object Fields:
- **id** (integer) - The ID of the response.
- **feedback** (string) - The response’s feedback.
- **feedback_date** (string/integer) - The response’s feedback date. Accepts `yyyy-mm-dd hh:mm:ss`, `yyyy-mm-dd hh:mm`, `yyyy-mm-dd`, or Unix Timestamp.
- **user_id** (string) - The user’s unique ID.
- **metric_type** (string) - Response’s metric type, one of `nps`, `csat`, `ces` or `other`.
- **score** (integer) - The response’s NPS, CSAT, CES or other score.
- **sentiment** (string) - Response’s sentiment, `positive`, `negative`, `neutral` or `null`.
- **project_ids** (integer[]) - Array of all associated Projects.
- **tags** (Hash[]) - A list of Tags associated with this response.
- **custom_properties** (Hash[]) - A list of associated custom properties for this response.

#### Response Example
```json
{
  "total_count": 10,
  "items": [
    {
      "id": 413,
      "project_ids": [
        5
      ],
      "feedback": "I wish your pricing model worked better for me. I need a custom plan.",
      "translated_feedback": null,
      "user_id": "mitsu.takasu@example1434.mx",
      "feedback_date": 1504948149,
      "score": 7,
      "metric_type": "ces",
      "custom_properties": [
        {
          "key": "pricing_plan",
          "data_type": "string",
          "value": "Lite"
        }
      ],
      "tags": [
        {
          "id": 93,
          "name": "TECHNICAL"
        }
      ],
      "sentiment": "positive",
      "wootric_response_id": null,
      "wootric_account_id": 38
    }
  ]
}
```
```

--------------------------------

### Get All Segments

Source: https://docs.wootric.com/api

Retrieve all segments for an account. Segments can be of type string, date, or integer.

```bash
curl -H "Authorization: Bearer myaccesstoken" "https://api.wootric.com/v1/segments"
```

--------------------------------

### Wootric SDK Configuration and Usage

Source: https://docs.wootric.com/ios

This section shows how to configure the Wootric SDK, set end-user information, and display surveys. It includes examples for setting a thank you link for promoters and skipping the feedback screen for them. It also demonstrates how to force a survey for testing purposes.

```APIDOC
## Wootric SDK Configuration and Usage

### Objective-C
```objectivec
#import <WootricSDK/WootricSDK.h>

// Configure Wootric with your client and account tokens
[Wootric configureWithClientID:clientID accountToken:accountToken];

// Set end-user information
[Wootric setEndUserEmail:@"nps@example.com"];
[Wootric setEndUserCreatedAt:@1234567890];

// Construct the App Store URL
// Replace YOUR_APP_ID with your application's id.
// e.g. https://itunes.apple.com/en/app/YOUR_APP_NAME/id123456789
// The app id would 123456789
NSURL *appStoreURL = [NSURL URLWithString:@"itms-apps://itunes.apple.com/WebObjects/MZStore.woa/wa/viewContentsUserReviews?id=YOUR_APP_ID&onlyLatestVersion=true&pageNumber=0&sortOrdering=1&type=Purple+Software"];

// Set ThankYouLink for promoters
[Wootric setPromoterThankYouLinkWithText:@"Rate our app!" URL:appStoreURL];

// Skip Feedback view for Promoters
[Wootric skipFeedbackScreenForPromoter:YES];

// Force survey for testing (do not use on production)
// [Wootric forceSurvey:YES];

// Show the survey
[Wootric showSurveyInViewController:self];
```

### Swift
```swift
import WootricSDK

// Configure Wootric with your client and account tokens
Wootric.configureWithClientID(clientID, accountToken:accountToken)

// Set end-user information
Wootric.setEndUserEmail("nps@example.com")
Wootric.setEndUserCreatedAt(1234567890)

// Construct the App Store URL
// Replace YOUR_APP_ID with your application's id.
// e.g. https://itunes.apple.com/en/app/YOUR_APP_NAME/id123456789
// The app id would 123456789
let appStoreURL = NSURL(string: "itms-apps://itunes.apple.com/WebObjects/MZStore.woa/wa/viewContentsUserReviews?id=YOUR_APP_ID&onlyLatestVersion=true&pageNumber=0&sortOrdering=1&type=Purple+Software")

// Set ThankYouLink for promoters
Wootric.setPromoterThankYouLinkWithText("Rate our app!", URL:appStoreURL)

// Skip Feedback view for Promoters
Wootric.skipFeedbackScreenForPromoter(true)

// Force survey for testing (do not use on production)
// Wootric.forceSurvey(true)

// Show the survey
Wootric.showSurveyInViewController(self)
```

### Swift (Modern Syntax)
```swift
import WootricSDK

// Configure Wootric with your client and account tokens
Wootric.configure(withClientID: clientID, accountToken:accountToken)

// Set end-user information
Wootric.setEndUserEmail("nps@example.com")
Wootric.setEndUserCreatedAt(1234567890)

// Construct the App Store URL
// Replace YOUR_APP_ID with your application's id.
// e.g. https://itunes.apple.com/en/app/YOUR_APP_NAME/id123456789
// The app id would 123456789
let appStoreURL = URL(string: "itms-apps://itunes.apple.com/WebObjects/MZStore.woa/wa/viewContentsUserReviews?id=YOUR_APP_ID&onlyLatestVersion=true&pageNumber=0&sortOrdering=1&type=Purple+Software")

// Set ThankYouLink for promoters
Wootric.setPromoterThankYouLinkWithText("Rate our app!", url:appStoreURL)

// Skip Feedback view for Promoters
Wootric.skipFeedbackScreen(forPromoter: true)

// Force survey for testing (do not use on production)
// Wootric.forceSurvey(true)

// Show the survey
Wootric.showSurvey(in: self)
```

### Notes
- You can set the last button to go to the App Store so users can rate your app.
- Ensure you replace `YOUR_APP_ID` with your actual App Store ID.
```

--------------------------------

### Get Imports

Source: https://docs.wootric.com/cxi

This endpoint retrieves a list of all imports in your account. It supports pagination parameters.

```APIDOC
## GET /v1/imports

### Description
Retrieves a list of all imports associated with the authenticated account.

### Method
GET

### Endpoint
`https://cxi-api.wootric.com/v1/imports`

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Max value is 30.
- **per_page** (integer) - Optional - The number of records to return per page. Defaults to 25. Max value is 50.

### Response
#### Success Response (200)
Returns a JSON array of Import objects.

```json
[
  {
    "id": 6,
    "name": "ai.csv",
    "source": "Intercom",
    "metric_type": "nps",
    "language": "en",
    "secondary_product_category_id": null,
    "response_count": 2,
    "created_at": 1590090287
  }
]
```
```

--------------------------------

### Create a New Project

Source: https://docs.wootric.com/cxi

Creates a new project in your account. The project name is provided as a form field. Requires a valid Bearer token.

```bash
curl -X POST -H "Authorization: Bearer myaccesstoken" "https://cxi-api.wootric.com/v1/projects" \
  -F project[name]="My new Project"
```

--------------------------------

### Create Project

Source: https://docs.wootric.com/cxi

Creates a new project within the authenticated account.

```APIDOC
## POST /v1/projects

### Description
This endpoint creates a project in your account.

### Method
POST

### Endpoint
https://cxi-api.wootric.com/v1/projects

### Parameters
#### Form Data Parameters
- **project[name]** (string) - Required - Project’s name

### Request Example
```curl
curl -X POST -H "Authorization: Bearer myaccesstoken" "https://cxi-api.wootric.com/v1/projects" \
  -F project[name]="My new Project"
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the newly created project.
- **name** (string) - The name of the project.
- **response_count** (integer) - The number of responses in this project.
- **created_at** (integer) - The project's creation date as a Unix Timestamp.

#### Response Example
```json
{
  "id": 8,
  "name": "My new Project",
  "response_count": 0,
  "created_at": 1611092961
}
```
```

--------------------------------

### Get Specific End User Settings

Source: https://docs.wootric.com/api

This endpoint retrieves the settings for a specific end user.

```APIDOC
## Get Specific End User Settings

### Description
This endpoint retrieves a specific end users settings.

### Method
GET

### Endpoint
https://api.wootric.com/v1/end_users/<end_user_id>/settings

### Parameters
#### Path Parameters
- **end_user_id** (integer) - Required - The ID of the end user.

### Response
#### Success Response (200)
- **id** (integer) - The ID of end user settings.
- **end_user_id** (integer) - The ID of end user.
- **created_at** (datetime) - Datetime representation of when the end user settings were created.
- **updated_at** (datetime) - Datetime representation of when the end user settings was last updated.
- **email_nps** (boolean) - Specifies whether end user should receive a survey through an email.

### Response Example
```json
{
  "id":1,
  "end_user_id":2,
  "created_at":"2015-04-20 04:46:51-08:00",
  "updated_at":"2015-04-20 04:46:51-08:00",
  "email_nps":true
}
```
```

--------------------------------

### Get a Specific Decline

Source: https://docs.wootric.com/api

Retrieves the details of a specific decline for an end user using their IDs.

```APIDOC
## GET /v1/end_users/{end_user_id}/declines/{id}

### Description
Retrieves a specific decline for an end user.

### Method
GET

### Endpoint
`https://api.wootric.com/v1/end_users/<end_user_id>/declines/<id>`

### Parameters
#### Path Parameters
- **end_user_id** (integer) - Required - The ID of the end user.
- **id** (integer) - Required - The ID of the decline to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the decline.
- **end_user_id** (integer) - The ID of the associated end user.
- **survey_id** (integer) - The ID of the survey.
- **ip_address** (string) - The IP address from which the decline originated.
- **origin_url** (string) - The URL from which the decline originated.
- **created_at** (string) - The timestamp when the decline was created.
- **updated_at** (string) - The timestamp when the decline was last updated.
- **end_user** (object) - Information about the end user.
  - **properties** (object) - Properties associated with the end user.

### Request Example
```bash
curl -H "Authorization: Bearer myaccesstoken" "https://api.wootric.com/v1/end_users/1/declines/1"
```

### Response Example
```json
{
    "id": 1,
    "end_user_id": 1,
    "survey_id": 10,
    "ip_address": "127.0.0.1",
    "origin_url": "https://wootric.com",
    "created_at": "2016-12-16 14:20:43 -0800",
    "updated_at": "2016-12-16 14:20:43 -0800",
    "end_user": {
        "properties": {
            "persona": "Individual",
            "pricing_plan": "Small Business",
            "product_plan": "Mobile",
            "purchase_date": 1473177881,
            "revenue_amount": 5000
        }
    }
}
```
```
Tokens:
Raw