Skip to content

info

Specification

  • Description:

  • Provides information about a particular slicer. This information includes the list of available key and data fields, as well as their descriptions. See example.

  • URL:

  • https://uslicer.iponweb.com/API/v2/info

  • URL arguments:

  • None

  • POST arguments (required unless marked optional):

  • slicer_name: the name of the report.

  • project_name: the name of the project.

  • token: the authorization token (see Authentication).

  • Output:

  • status: the status of the request. success, if the request was processed successfully, or error code, if any error occurred. If the status is not success, then the response contains the status and reason fields only. Possible values:

    • 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.
  • reason: user-friendly description of the occurred error. This field is displayed for failed requests only.

  • annotation: slicer annotation. Possible values:

    • null (if no annotation exists for the slicer specified by the **slicer_name **POST argument).
    • annotation text (if any annotation exists for the slicer specified by the **slicer_name **POST argument).
    • key_fields: the list of key fields available for the report specified by the project_name and slicer_name POST arguments.
    • name: key field name.
    • aliases: the list of all aliases for the 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.
    • aliases: the list of all aliases for the 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 the 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.
    • display_pattern: display pattern for the data column. Possible values: null for common data columns and any_characters{}any_characters for custom data columns, where **{} ** represents custom data column value.
    • timezone: default 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.
    • additional_info: the dictionary with additional information about the slicer specified by the project_name and slicer_name POST arguments.
    • slicer_id: the id of the slicer specified by the project\_name and slicer\_name POST arguments.
    • project_limited: the maximum number of simultaneous connections from the user interface. Possible values: any integer number from 0 to MAX_INT32.
    • api_limited: the maximum number of simultaneous connections from the API. Possible values: any integer number from 0 to MAX_INT32. Used for bots only.
    • tracking: defines whether a customized logo is used. Possible values: 0- a customized logo is used, 1- no customized logo is used.
    • show_audience: defines whether to show Audience in the user interface. Possible values: 0- don’t show Audience, 1- show Audience.
    • autocomplete: defines whether to autocomplete key field names in filters. Possible values: 0- don’t autocomplete, 1- autocomplete.
    • has\_microsoft\_token: defines whether a Microsoft token exists. This token is used for exporting reports to OneDrive. Possible values: false- Microsoft token doesn't exist, true- Microsoft token exists.

Example

Purpose: Get the list of key and data fields (with their descriptions)available for the Traffic Demo slicer of the demo project.

Path:

https://uslicer.iponweb.com/API/v2/info

POST Arguments:

{
   "slicer_name": "Traffic Demo",
   "project_name": "demo",
   "token": "<token>"

}

Command:

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

Response:

{
   "key_fields" : [
      {
         "description" : "Campaign ID",
         "type" : "int",
         "name" : "campaign_id",
         "is_segmented" : 0
      },
      {
         "description" : "Creative ID",
         "type" : "int",
         "name" : "creative_id",
         "is_segmented" : 0
      },
      {
         "name" : "conversion_id",
         "is_segmented" : 0,
         "description" : "Conversion ID",
         "type" : "int"
      },
      {
         "name" : "size",
         "is_segmented" : 0,
         "description" : "Size",
         "type" : "text"
      },
      {
         "name" : "geo_country",
         "is_segmented" : 0,
         "description" : "Geo Country",
         "type" : "text"
      },
      {
         "description" : "Geo Region",
         "type" : "text",
         "name" : "geo_region",
         "is_segmented" : 0
      },
      {
         "type" : "text",
         "description" : "Geo City",
         "is_segmented" : 0,
         "name" : "geo_city"
      },
      {
         "description" : "Geo Dma",
         "type" : "int",
         "name" : "geo_dma",
         "is_segmented" : 0
      },
      {
         "name" : "geo_zip",
         "is_segmented" : 0,
         "description" : "Geo Zip",
         "type" : "text"
      },
      {
         "name" : "browser",
         "is_segmented" : 0,
         "description" : "Browser",
         "type" : "text"
      },
      {
         "name" : "operating_system",
         "is_segmented" : 0,
         "description" : "Operating System",
         "type" : "text"
      },
      {
         "name" : "google_main_vertical",
         "is_segmented" : 0,
         "description" : "Google Main Vertical",
         "type" : "int"
      },
      {
         "name" : "language",
         "is_segmented" : 0,
         "description" : "Language",
         "type" : "text"
      },
      {
         "description" : "Slot Visibility",
         "type" : "text",
         "name" : "slot_visibility",
         "is_segmented" : 0
      },
      {
         "link" : "domain",
         "name" : "domain",
         "is_segmented" : 0,
         "description" : "Domain",
         "type" : "text"
      },
      {
         "description" : "Segments",
         "type" : "int",
         "name" : "segments",
         "is_segmented" : 1
      },
      {
         "type" : "text",
         "description" : "Year",
         "is_segmented" : 0,
         "name" : "granularity_year"
      },
      {
         "name" : "granularity_quarter",
         "is_segmented" : 0,
         "description" : "Quarter",
         "type" : "text"
      },
      {
         "name" : "granularity_month",
         "is_segmented" : 0,
         "description" : "Month",
         "type" : "text"
      },
      {
         "type" : "text",
         "description" : "Week",
         "is_segmented" : 0,
         "name" : "granularity_week"
      },
      {
         "is_segmented" : 0,
         "name" : "granularity_day",
         "type" : "text",
         "description" : "Day"
      }
   ],
   "timezone" : 0,
   "first_date" : "2012-02-01",
   "status" : "success",
   "last_date" : "2012-03-31",
   "annotation" : null,
   "data_fields" : [
      {
         "display_type" : "int",
         "show_percents" : 2,
         "display_precision" : 0,
         "is_optional" : 0,
         "access" : null,
         "description" : "Impressions",
         "formula" : null,
         "name" : "imps",
         "formula_description" : null
      },
      {
         "formula" : null,
         "description" : "Bids",
         "access" : null,
         "formula_description" : null,
         "name" : "bids",
         "display_type" : "int",
         "is_optional" : 0,
         "display_precision" : 0,
         "show_percents" : 2
      },
      {
         "access" : null,
         "description" : "Clicks",
         "formula" : null,
         "name" : "clicks",
         "formula_description" : null,
         "display_type" : "int",
         "show_percents" : 1,
         "display_precision" : 0,
         "is_optional" : 0
      },
      {
         "show_percents" : 0,
         "display_precision" : 3,
         "is_optional" : 0,
         "display_type" : "percent",
         "name" : "ctr",
         "formula_description" : "clicks / imps",
         "description" : "CTR",
         "formula" : "clicks / imps",
         "access" : null
      },
      {
         "display_type" : "int",
         "display_precision" : 0,
         "show_percents" : 1,
         "is_optional" : 0,
         "description" : "PVC",
         "access" : null,
         "formula" : null,
         "name" : "pvc",
         "formula_description" : null
      },
      {
         "formula_description" : null,
         "name" : "pcc",
         "access" : null,
         "description" : "PCC",
         "formula" : null,
         "is_optional" : 0,
         "display_precision" : 0,
         "show_percents" : 1,
         "display_type" : "int"
      },
      {
         "description" : "Win Bid CPM",
         "formula" : "winner_bid_price / imps * 1000",
         "access" : null,
         "name" : "win_bid_shown",
         "formula_description" : "winner_bid_price / imps * 1000",
         "display_type" : "float",
         "display_precision" : 2,
         "show_percents" : 0,
         "is_optional" : 0
      },
      {
         "name" : "pub_payout",
         "formula_description" : null,
         "description" : "Cost",
         "access" : null,
         "formula" : null,
         "show_percents" : 1,
         "display_precision" : 2,
         "is_optional" : 0,
         "display_type" : "float"
      },
      {
         "display_type" : "float",
         "show_percents" : 0,
         "display_precision" : 3,
         "is_optional" : 0,
         "description" : "eCPM",
         "access" : null,
         "formula" : "pub_payout / imps * 1000",
         "name" : "ecpm",
         "formula_description" : "pub_payout / imps * 1000"
      },
      {
         "is_optional" : 0,
         "display_precision" : 3,
         "show_percents" : 0,
         "display_type" : "float",
         "formula_description" : "pub_payout / clicks",
         "name" : "ecpc",
         "description" : "eCPC",
         "formula" : "pub_payout / clicks",
         "access" : null
      },
      {
         "display_type" : "int",
         "show_percents" : 0,
         "display_precision" : 0,
         "is_optional" : 1,
         "description" : "country",
         "access" : "private",
         "formula" : "map(test_mapping)",
         "name" : "custom_column_8565",
         "formula_description" : "map(test_mapping)"
      }
   ],
   "supports_timezone" : 0
}