Configuration Structure

This is an example showing the JSON structure for all possible keys in the configuration file.

📘

This page shows a maximally-specified configuration file. You probably have a much simpler configuration as described here.

{
    "clientId": "your_client_id",
    "measures": [
        {
            "surveyId": "survey_id1",
            "launchCount": 4,
            "daysSinceFirstLaunch": 5,
            "daysSinceLastLaunch": 7,
            "pageViews": 10,
            "significantEventThresholds": {
                "event1": 6,
                "event2": 7
            }
        },
        {
            "surveyId": "survey_id2",
            "launchCount": 8,
            "daysSinceFirstLaunch": 9,
            "significantEventThresholds": {
                "event3": 10,
                "event4": 11
            },
            "combinedCriteria": [
                {
                    "pageViews": 6,
                    "launchCount": 7
                },
                {
                    "daysSinceLastLaunch": 6,
                    "significantEventThresholds": {
                        "event5": 9
                    }
                }
            ]
        }
    ],
    "cppParameters": {
        "MyCPP": "CPP #1",
        "AnotherCPP": "CPP #2"
    },
    "appName": "your_app_name",
    "invite": {
        "logo": "bitmap.png",
        "header": "masthead.png",
        "baseColor": [200, 12, 219]
    },
    "survey": {
        "closeButtonColor": [71, 221, 22],
        "closeButtonBackgroundColor": [16, 71, 198],
        "headerColor": [187, 87, 251]
    },
    "repeatDaysAfterDecline": 1,
    "repeatDaysAfterComplete": 2,
    "repeatDaysAfterAccept": 3,
    "notificationType": "LOCAL",
    "enableWhitelist":true,
    "feedback": {
        "feedbackSurveys": [
            {
                "name": "<YOUR FEEDBACK SURVEY NAME>",
                "feedbackId": "<YOUR FEEDBACK SURVEY ID>"
            },
            {
                "name": "<YOUR FEEDBACK SURVEY NAME>",
                "feedbackId": "<YOUR FEEDBACK SURVEY ID>",
                "surveyCompletionPageDelay": -1
            }
        ],
      "surveyCompletionPageDelay": 3
    },
    "supportLandscape": true,
    "emailOnlyContactNotification": true
}