Skip to main content

Request personalization's results

POST 
/personalizations/:personalizationId/results

Send a request to generate the report for the results of the given personalization

Request​

Path Parameters

    personalizationId int64required

Body

required

    interval stringdeprecated

    Time interval for which data is segmented in the report. Deprecated. Use breakdown with IntervalBreakdown type instead.

    Possible values: [HOUR, DAY, WEEK, MONTH, YEAR]

    visitorData boolean

    Set to true to only include data from unique visitors. By default, the report includes all visitor data.

    Default value: false
    allVariationsData boolean

    Set to true to include data from all variations at once.

    Default value: false
    bayesian boolean

    Enables the current Bayesian result probability for the experiment in the report.

    Default value: false
    sequentialTesting boolean

    Enables the sequential testing result for the experiment in the report.

    Default value: false
    enabledMultipleTesting boolean

    Enables multiple testing correction for the experiment in the report.

    Default value: false
    referenceVariationId string

    Unique ID of the variation that you want to use as the reference variation.

    breakdown

    object

    oneOf

    Breakdown request argument for splitting data

    type string

    Type of breakdown. Types CUSTOM_DATUM and CROSS_CAMPAIGN have additional fields.

    Possible values: [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, KEY_PAGE, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE, CROSS_CAMPAIGN, SDK, SDK_VERSION, INTERVAL]

    goalsIds int64[]

    Specifies which goals to include in the report. Use an empty list [] to exclude all goals. Use null to include all goals. Use a list of goal IDs [123, 456] to include only those goals.

    goalIdsCuped int64[]

    Specifies which CUPED goals to include in the report. Use an empty list [] to exclude all CUPED goals. Use null to include all CUPED goals. Use a list of CUPED goal IDs [123, 456] to include only those goals.

    filters

    object[]

    List of filters to apply to the data included in the report.

  • Array [

    • oneOf

    type stringrequired
    include boolean

  • ]

    • dateIntervals

    object[]

    required

    Date boundaries to include only the results from the specified time period(s).

  • Array [

    • start date-time

    Start timestamp

    end date-time

    End timestamp

  • ]

    • conversionType stringrequired

    Type of conversions to use for calculating reliability, improvement rate and etc

    Possible values: [ALL_CONVERSION, CONVERTED_VISITS]

    exportOptions

    object

    Options for XLSX/PDF exportation.

    format string

    Format that you want to export the report data to.

    Possible values: [XLSX, PDF]

    view string

    Type of data view for XLS. Result data will be arranged and broken down depending on this parameter

    Possible values: [PER_GOAL, PER_VARIATION, PER_AUDIENCE, ALL_IN_ONE]

    columns string[]

    Columns for XLS export

    Possible values: [VISITS, VISITORS, VISITS_CONVERTED, VISITORS_CONVERTED, ALL_CONVERSIONS, RATIO_VALUE, REVENUE_PER_VISIT, REVENUE_PER_VISITOR, AVERAGE_CART_VISITS, AVERAGE_CART_VISITORS, CONVERSION_RATE_VISITS, IMPROVEMENT_RATE_VISITS, RELIABILITY_RATE_VISITS, CONVERSION_RATE_VISITORS, IMPROVEMENT_RATE_VISITORS, RELIABILITY_RATE_VISITORS, CONVERSION_RATE_ALL_VISITS, IMPROVEMENT_RATE_ALL_VISITS, CONVERSION_RATE_ALL_VISITORS, IMPROVEMENT_RATE_ALL_VISITORS, PROBABILITY_TO_WIN, CREDIBLE_INTERVAL, IMPROVEMENT_RANGE_DEFAULT, CONVERSION_RATE_CUPED, IMPROVEMENT_RATE_CUPED, RELIABILITY_RATE_CUPED, IMPROVEMENT_RANGE_CUPED, RELIABILITY_RATE_SEQUENTIAL, IMPROVEMENT_RANGE_SEQUENTIAL, CONVERSION_RATE_MULTIPLE_TESTING, IMPROVEMENT_RATE_MULTIPLE_TESTING, RELIABILITY_RATE_MULTIPLE_TESTING, REVENUE]

    filterLabels string[]
    variationsIds int64[]
    useReferenceVariation boolean
    callbackUrl string

    Callback URL that you want to send the data response to.

Responses​

OK

Schema

    dataCode string

    Hash code containing information about the data request, such as dates, goals, variations, format, filters, and so on. Use this code in the AudienceController#poll or DataController functions to obtain actual results. There are two possible formats for the code, depending on the context: 123...123 or 123...123|123...123. For example, AudienceController#global generates the latter.

    Example: 89599333501501534304101214660291496129464311669540935471556471877530843827432
Loading...