Info Endpoint

Provides information about a particular slicer. This information includes the list of available key and data fields, as well as their descriptions. There are no request fields for this, apart from those required for all requests, i.e. slicer_name, project_name, token. See the Always Required Fields section for details

# Info Endpoint
https://uslicer.iponweb.com/API/v2/info

# Example Request
curl -H "Content-Type: application/json" -H "Accept: application/json" \
  "https://uslicer.iponweb.com/API/v2/info" \
  --data '{ "slicer_name": "Demo Example", "project_name": "example", "token": "<token>"}'

Response Fields

Field	Description
status	Returns the status of the request, success if the request was processed successfully, or an error code if any error occurred. If the request is not successful, then the response contains the status and reason fields only. success the request was processed successfully. bad_request invalid request parameters, please see the reason field for more details. timeout the request took too long to complete. access_error the user doesn’t have access to the specified project/slicer, or a wrong token was used. internal_error the request failed due to an unknown problem.
timezone	The slicer time zone.
supports_timezone	time zone support sign. Possible values: 1: time zone is supported. 0: time zone is not supported.
first_date	The first date with available data for the slicer specified by the slicer_name POST argument. Format: YYYY-MM-DD.
last_date	The last date with available data for the slicer specified by the slicer_name POST argument. Format: YYYY-MM-DD.
key_fields	The key fields available for the report specified by the project_name and slicer_name POST arguments name key field name. description key field full name. type key field type. Possible values: int and text mapping key field mapping or null (if key field mapping doesn’t exist). is_segmented key field segmentation sign. Possible values: 1 the field is segmented. 0 the field is not segmented.
data_fields	the list of data fields available for the report specified by the project_name and slicer_name POST arguments. name data field name. description data field full name. type data field type, either int, float, or percent display_precision default precision for visual display. is_optional defines data field display importance. Possible values: 1 data field display is optional (the data field is not displayed in UI, when the Slicer is initially opened, but it can be added later), 0 data field display is required (the data field is displayed in UI, when the Slicer is initially opened). show_percent defines whether to show percent column in user interface. Possible values: 0 don’t show percent 1 show percent only when sorting by the field, 2 always show percent. formula data field formula. Possible values: null for common data fields. data field calculation logic for derived fields. formula_description data field formula description. Possible values: null for common data fields. data field formula description for derived data fields. access access permission. Possible values: null/ shared / private. null value is set for common data fields only. shared/private values are set for custom data fields only. shared value means that the custom data column is available for all users. private value means that the custom data column is available for its creator only.

Response Example

{
    "annotation": null,
    "audience_sources": [
        {
            "annotation": "",
            "description": "UserID",
            "name": "audience"
        }
    ],
    "data_fields": [
        {
            "access": null,
            "annotation": "",
            "description": "Yes Bids",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "bids",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "No Bids",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "nobids",
            "show_percents": 1
        },
        {
            "access": null,
            "annotation": "",
            "description": "Impressions",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "imps",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Clicks",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "clicks",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Bid Amount",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "bid_amount",
            "show_percents": 1
        },
        {
            "access": null,
            "annotation": "",
            "description": "Winning Bid",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "win_bid_amount",
            "show_percents": 1
        },
        {
            "access": null,
            "annotation": "",
            "description": "Fraudulent Clicks Filtered",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "anomaly_clicks_filtered",
            "show_percents": 1
        },
        {
            "access": null,
            "annotation": "",
            "description": "Post-View Conversions (PVC)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "pv_convs",
            "show_percents": 1
        },
        {
            "access": null,
            "annotation": "",
            "description": "Post-Click Conversions (PCC)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "pc_convs",
            "show_percents": 1
        },
        {
            "access": null,
            "annotation": "",
            "description": "Advertiser Spend",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "payout.adv_payout",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Actual Media Cost",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "payout.actual_pub",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "PV Conversions",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "pv_conversions",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "PC Conversions",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "pc_conversions",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Attributed PVC",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "attributed_pv_convs",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Attributed PCC",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "attributed_pc_convs",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "VAST Impressions",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_imp",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "VAST Events (video start)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_start",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "VAST Events (25% complete)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_25",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "VAST Events (50% complete)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_50",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "VAST Events (75% complete)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_75",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "VAST Events (100% complete)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_complete",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Vast Events (errors)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_error",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Vast Events (30 seconds)",
            "display_pattern": null,
            "display_precision": 0,
            "display_type": "int",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "vast_progress_30",
            "show_percents": 2
        },
        {
            "access": null,
            "annotation": "",
            "description": "Viewable Impressions",
            "display_pattern": null,
            "display_precision": 2,
            "display_type": "float",
            "formula": null,
            "formula_description": null,
            "is_optional": 0,
            "name": "viewable_imps",
            "show_percents": 2
        }
    ],
    "first_date": "2019-10-21",
    "key_fields": [
        {
            "annotation": "",
            "description": "Advertiser",
            "is_segmented": 0,
            "mapping": "bid_context_wrapper.demand.advertiser_id_mapping",
            "name": "bid_context_wrapper.demand.advertiser_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Campaign",
            "is_segmented": 0,
            "mapping": "bid_context_wrapper.demand.campaign_id_mapping",
            "name": "bid_context_wrapper.demand.campaign_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Line Item",
            "is_segmented": 0,
            "mapping": "bid_context_wrapper.demand.line_item_id_mapping",
            "name": "bid_context_wrapper.demand.line_item_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Creative",
            "is_segmented": 0,
            "mapping": "bid_context_wrapper.demand.creative_id_mapping",
            "name": "bid_context_wrapper.demand.creative_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "SSP",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.bid.ssp",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Publisher ID",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.supply.publisher_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Site ID",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.supply.site_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Page Position",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.supply.visibility",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Protocol",
            "is_segmented": 0,
            "mapping": "is_secure_request_mapping",
            "name": "is_secure_request",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Country",
            "is_segmented": 0,
            "mapping": "country_name",
            "name": "bid_context_wrapper.user.geo.country",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Region",
            "is_segmented": 0,
            "mapping": "region_name",
            "name": "bid_context_wrapper.user.geo.country_region",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "City",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.geo.city",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "DMA",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.geo.dma",
            "type": "int"
        },
        {
            "annotation": "",
            "description": "Postal Code",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.geo.zip",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Browser",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.browser.name",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Browser Version",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.browser.version",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "OS",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.os.name",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "OS Version",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.os.version",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Device Type",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.device.type",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Device Model",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.device.model",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Device Manufacturer",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.user.agent.device.maker",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Browser Language",
            "is_segmented": 1,
            "mapping": "language_name",
            "name": "languages_list",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Site Domain",
            "is_segmented": 0,
            "link": "domain",
            "mapping": null,
            "name": "bid_context_wrapper.supply.site_domain",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Page Domain",
            "is_segmented": 0,
            "link": "domain",
            "mapping": null,
            "name": "bid_context_wrapper.supply.page_domain",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Conversion ID",
            "is_segmented": 1,
            "mapping": "conversion_id_mapping",
            "name": "conversion_id",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Blocked Content Categories",
            "is_segmented": 1,
            "mapping": null,
            "name": "blocked_adv_categories",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Content Categories",
            "is_segmented": 1,
            "mapping": null,
            "name": "content_categories",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Detected Fraud Source",
            "is_segmented": 0,
            "mapping": null,
            "name": "anomaly_segment",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Creative Tag Type",
            "is_segmented": 0,
            "mapping": null,
            "name": "bid_context_wrapper.demand.tag_type",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Requested Creative Size",
            "is_segmented": 1,
            "mapping": null,
            "name": "requested_sizes",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Audience Segment",
            "is_segmented": 1,
            "mapping": null,
            "name": "segments_list",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Traffic Type",
            "is_segmented": 0,
            "mapping": "is_app_mapping",
            "name": "is_app",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Time of Day",
            "is_segmented": 0,
            "mapping": null,
            "name": "hour_str",
            "type": "int"
        },
        {
            "annotation": "",
            "description": "Year",
            "is_segmented": 0,
            "mapping": null,
            "name": "granularity_year",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Quarter",
            "is_segmented": 0,
            "mapping": null,
            "name": "granularity_quarter",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Month",
            "is_segmented": 0,
            "mapping": null,
            "name": "granularity_month",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Week",
            "is_segmented": 0,
            "mapping": null,
            "name": "granularity_week",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Day",
            "is_segmented": 0,
            "mapping": null,
            "name": "granularity_day",
            "type": "text"
        },
        {
            "annotation": "",
            "description": "Day & Hour",
            "is_segmented": 0,
            "mapping": null,
            "name": "granularity_hour",
            "type": "text"
        }
    ],
    "last_date": "2019-10-29",
    "status": "success",
    "supports_timezone": 1,
    "timezone": 0
}