GET/constructor_filters/api/

Returns a list of available report parameters.

Request format

https://distribution.yandex.ru/api/v2/constructor_filters/api/
  ? [[lang](*lang)=<string>]

lang

Response language. Acceptable values:

  • en — English
  • ru — Russian
  • tr — Turkish

If the value is omitted, the interface language is used.

Response format

{
  "data": {
    "blocks": [
      {
        "id": "{string}",
        "fields": [
          {
            "id": "{string}",
            "value": "{string}",
            "choices": [
              {
                "id": "{string}",
                "label": "{string}",
                "slug": "{string}"
              }
            ]
          }
        ]
      }
    ]
  },
  "result": "{string}"
}

Example for JSON

Request:

curl -i -H "Accept: application/json" -H "Authorization: OAuth 66..." -X GET "https://distribution.yandex.ru/api/v2/constructor_filters/api/?lang=en"
Response example
HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Tue, 24 Jan 2017 11:55:25 GMT
Content-Type: application/json
Content-Length: 11.59KB
Connection: keep-alive

{
  "data": {
    "blocks": [
      {
        "id": "filters",
        "fields": [
          {
            "id": "detalization",
            "value": "1",
            "choices": [
              {
                "id": "1",
                "label": "By days",
                "slug": "by_days"
              },
              {
                "id": "2",
                "label": "By weeks",
                "slug": "by_weeks"
              },
              {
                "id": "3",
                "label": "By months",
                "slug": "by_months"
              },
              {
                "id": "4",
                "label": "By quarters",
                "slug": "by_quarters"
              },
              {
                "id": "5",
                "label": "By years",
                "slug": "by_years"
              },
              {
                "id": "6",
                "label": "Without groupings",
                "slug": "without_detalization"
              }
            ]
          },
          {
            "id": "period",
            "value": null
          }
        ]
      },
      {
        "id": "measures",
        "fields": [
          {
            "id": "Metrics",
            "value": [
              {
                "id": "mmarketwidgetvisitsstatistics_widget_visits",
                "value": false,
                "label": "Visits to the Market"
              },
              {
                "id": "mrevenuesharestatistics_rs_clicks",
                "value": false,
                "label": "Clicks for Direct"
              },
              {
                "id": "mmarketcparsstatistics_market_cpa_orders",
                "value": false,
                "label": "Paid orders on Yandex Market"
              },
              {
                "id": "mmarketrsstatistics_market_clicks_cpc",
                "value": false,
                "label": "Paid clicks on Yandex Market"
              },
              {
                "id": "mmarketapprovedordersstatistics_orders",
                "value": false,
                "label": "Approved orders"
              },
              {
                "id": "msearchstatistics_searches",
                "value": false,
                "label": "Searches"
              },
              {
                "id": "mrevenuesharestatistics_rs_shows",
                "value": false,
                "label": "Views for Direct"
              },
              {
                "id": "mmarketcreatedordersstatistics_partner_wo_nds",
                "value": false,
                "label": "Potential reward for created orders"
              },
              {
                "id": "mmarketcreatedordersstatistics_orders",
                "value": false,
                "label": "Created orders"
              }
            ],
            "label": "Metrics"
          },
          {
            "id": "analitics",
            "value": [
              {
                "id": "mrevenuesharestatistics_cpc_partner_direct",
                "value": false,
                "label": "CPC partner Direct"
              },
              {
                "id": "mrevenuesharestatistics_cpm_partner_direct",
                "value": false,
                "label": "CPM partner Direct"
              },
              {
                "id": "mrevenuesharestatistics_ctr_direct",
                "value": false,
                "label": "CTR for Direct"
              },
              {
                "id": "mmarketcparsstatistics_market_eCPA",
                "value": false,
                "label": "Yandex Market eCPA"
              },
              {
                "id": "mmarketpartnerwidgetstatistics_eCPA_approved",
                "value": false,
                "label": "eCPA for confirmed orders"
              },
              {
                "id": "mmarketpartnerwidgetstatistics_eCPA_created",
                "value": false,
                "label": "eCPA for created orders"
              },
              {
                "id": "mmarketrsstatistics_market_eCPC",
                "value": false,
                "label": "eCPC"
              },
              {
                "id": "mmarketpartnerwidgetstatistics_clickout_conversion",
                "value": false,
                "label": "Conversion to a paid click of the Market from the display of the widget"
              },
              {
                "id": "mmarketpartnerwidgetstatistics_conversion_to_order",
                "value": false,
                "label": "Conversion to a created order"
              },
              {
                "id": "mmarketpartnerwidgetstatistics_conversion_visits_to_order",
                "value": false,
                "label": "Conversion to a created order from a visit to the Market"
              }
            ],
            "label": "Analytical metrics"
          },
          {
            "id": "partner_reward",
            "value": [
              {
                "id": "default_fixed_partner_reward_metric",
                "value": false,
                "label": "Reward"
              },
              {
                "id": "mdiscoverypartnerstatistics_partner_wo_nds",
                "value": false,
                "label": "for RS Discovery"
              },
              {
                "id": "mrevenuesharestatistics_partner_wo_nds",
                "value": false,
                "label": "for RS Direct"
              },
              {
                "id": "mmarketrsstatistics_partner_wo_nds",
                "value": false,
                "label": "for paid clicks on Yandex Market"
              },
              {
                "id": "mmarketapprovedordersstatistics_partner_wo_nds",
                "value": false,
                "label": "for approved orders on YandexMarket"
              }
            ],
            "label": "Partner reward"
          }
        ]
      },
      {
        "id": "conditional_filters",
        "fields": [
          {
            "id": "CLIDs and Sets",
            "value": [
              {
                "id": "default_constructor_field_clid_container",
                "value": [
                  {
                    "id": "default_constructor_field_clid_group",
                    "value": false,
                    "label": "CLID"
                  },
                  {
                    "id": "default_constructor_field_clid_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_clid",
                    "value": null
                  }
                ]
              },
              {
                "id": "default_constructor_field_clid_type_id_container",
                "value": [
                  {
                    "id": "default_constructor_field_clid_type_id_group",
                    "value": false,
                    "label": "Tool/CLID type"
                  },
                  {
                    "id": "default_constructor_field_clid_type_id_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_clid_type_id",
                    "value": [],
                    "choices": [
                      {
                        "id": "2023",
                        "label": "Alice"
                      },
                      {
                        "id": "1003",
                        "label": "Search widget"
                      },
                      {
                        "id": "5",
                        "label": "Home page"
                      },
                      {
                        "id": "1011",
                        "label": "Discovery revenue"
                      },
                      {
                        "id": "7",
                        "label": "Yandex button in Visual Bookmarks"
                      },
                      {
                        "id": "11",
                        "label": "Yandex button in the Opera side panel"
                      },
                      {
                        "id": "21",
                        "label": "Market. Advisor for websites"
                      },
                      {
                        "id": "27",
                        "label": "Partner links"
                      },
                      {
                        "id": "12",
                        "label": "Search in the Opera side panel"
                      },
                      {
                        "id": "9",
                        "label": "Search in the browser address bar"
                      },
                      {
                        "id": "1002",
                        "label": "Search in the notification panel"
                      },
                      {
                        "id": "100003",
                        "label": "Search in the search form on the partner site"
                      },
                      {
                        "id": "8",
                        "label": "Search form in Visual Bookmarks"
                      },
                      {
                        "id": "6",
                        "label": "Search form in the browser"
                      },
                      {
                        "id": "1004",
                        "label": "Search form in the app"
                      },
                      {
                        "id": "100016",
                        "label": "Yandex Games link"
                      },
                      {
                        "id": "20",
                        "label": "Link to Yandex Market"
                      },
                      {
                        "id": "25",
                        "label": "Link to Yandex Market from Adviser"
                      },
                      {
                        "id": "15",
                        "label": "Link to Yandex from the  \"Favorites\" Bookmarks bar"
                      },
                      {
                        "id": "1",
                        "label": "Unique install"
                      }
                    ]
                  }
                ]
              },
              {
                "id": "default_constructor_field_set_domain_container",
                "value": [
                  {
                    "id": "default_constructor_field_set_domain_group",
                    "value": false,
                    "label": "Set domain"
                  },
                  {
                    "id": "default_constructor_field_set_domain_operation",
                    "value": "3",
                    "choices": [
                      {
                        "id": "3",
                        "label": "Contains"
                      },
                      {
                        "id": "4",
                        "label": "Does not contain"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_set_domain",
                    "value": null
                  }
                ]
              },
              {
                "id": "default_constructor_field_set_caption_container",
                "value": [
                  {
                    "id": "default_constructor_field_set_caption_group",
                    "value": false,
                    "label": "Set name"
                  },
                  {
                    "id": "default_constructor_field_set_caption_operation",
                    "value": "3",
                    "choices": [
                      {
                        "id": "3",
                        "label": "Contains"
                      },
                      {
                        "id": "4",
                        "label": "Does not contain"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_set_caption",
                    "value": null
                  }
                ]
              },
              {
                "id": "default_constructor_field_set_id_container",
                "value": [
                  {
                    "id": "default_constructor_field_set_id_group",
                    "value": false,
                    "label": "Set ID"
                  },
                  {
                    "id": "default_constructor_field_set_id_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_set_id",
                    "value": null
                  }
                ]
              }
            ],
            "label": "CLIDs and sets"
          },
          {
            "id": "Contracts",
            "value": [
              {
                "id": "default_constructor_field_external_id_parent_container",
                "value": [
                  {
                    "id": "default_constructor_field_external_id_parent_group",
                    "value": false,
                    "label": "External ID"
                  },
                  {
                    "id": "default_constructor_field_external_id_parent_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      },
                      {
                        "id": "3",
                        "label": "Contains"
                      },
                      {
                        "id": "4",
                        "label": "Does not contain"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_external_id_parent",
                    "value": null
                  }
                ]
              }
            ],
            "label": "Contracts"
          },
          {
            "id": "Packs",
            "value": [
              {
                "id": "default_constructor_field_vid_container",
                "value": [
                  {
                    "id": "default_constructor_field_vid_group",
                    "value": false,
                    "label": "VID"
                  },
                  {
                    "id": "default_constructor_field_vid_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_vid",
                    "value": null
                  }
                ]
              },
              {
                "id": "default_constructor_field_soft_id_container",
                "value": [
                  {
                    "id": "default_constructor_field_soft_id_group",
                    "value": false,
                    "label": "Soft"
                  },
                  {
                    "id": "default_constructor_field_soft_id_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_soft_id",
                    "value": [],
                    "choices": [
                      {
                        "id": "999",
                        "label": "Minorities"
                      },
                      {
                        "id": "1002",
                        "label": "Mobile Opera"
                      },
                      {
                        "id": "3",
                        "label": "Opera"
                      },
                      {
                        "id": "1013",
                        "label": "Browser settings"
                      },
                      {
                        "id": "11",
                        "label": "Yandex app"
                      },
                      {
                        "id": "1025",
                        "label": "Adviser. Browser extension"
                      },
                      {
                        "id": "1000",
                        "label": "Third-party site"
                      },
                      {
                        "id": "8",
                        "label": "Third-party soft"
                      },
                      {
                        "id": "1170",
                        "label": "Yandex Games"
                      },
                      {
                        "id": "1046",
                        "label": "Yandex Market (marketplace)"
                      },
                      {
                        "id": "1033",
                        "label": "Yandex Market (ad platform)"
                      }
                    ]
                  }
                ]
              },
              {
                "id": "default_constructor_field_pack_id_container",
                "value": [
                  {
                    "id": "default_constructor_field_pack_id_group",
                    "value": false,
                    "label": "Pack ID"
                  },
                  {
                    "id": "default_constructor_field_pack_id_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_pack_id",
                    "value": null
                  }
                ]
              },
              {
                "id": "default_constructor_field_pack_caption_container",
                "value": [
                  {
                    "id": "default_constructor_field_pack_caption_group",
                    "value": false,
                    "label": "Pack name"
                  },
                  {
                    "id": "default_constructor_field_pack_caption_operation",
                    "value": "3",
                    "choices": [
                      {
                        "id": "3",
                        "label": "Contains"
                      },
                      {
                        "id": "4",
                        "label": "Does not contain"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_pack_caption",
                    "value": null
                  }
                ]
              },
              {
                "id": "default_constructor_field_pack_traffic_id_container",
                "value": [
                  {
                    "id": "default_constructor_field_pack_traffic_id_group",
                    "value": false,
                    "label": "Platform"
                  },
                  {
                    "id": "default_constructor_field_pack_traffic_id_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_pack_traffic_id",
                    "value": "-1",
                    "choices": [
                      {
                        "id": "-1",
                        "label": "All"
                      },
                      {
                        "id": "1",
                        "label": "Desktop"
                      },
                      {
                        "id": "4",
                        "label": "Mobile"
                      }
                    ]
                  }
                ]
              },
              {
                "id": "default_constructor_field_pack_country_id_container",
                "value": [
                  {
                    "id": "default_constructor_field_pack_country_id_group",
                    "value": false,
                    "label": "Pack country"
                  },
                  {
                    "id": "default_constructor_field_pack_country_id_operation",
                    "value": "1",
                    "choices": [
                      {
                        "id": "1",
                        "label": "In list"
                      },
                      {
                        "id": "2",
                        "label": "Not in list"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_pack_country_id",
                    "value": [],
                    "choices": [
                      {
                        "id": "8",
                        "label": "Earth"
                      },
                      {
                        "id": "6",
                        "label": "CUBR"
                      },
                      {
                        "id": "1",
                        "label": "Russia"
                      },
                      {
                        "id": "3",
                        "label": "Russia+CIS"
                      },
                      {
                        "id": "7",
                        "label": "Russia+CIS+Turkey"
                      },
                      {
                        "id": "4",
                        "label": "Turkey"
                      }
                    ]
                  }
                ]
              },
              {
                "id": "default_constructor_field_pack_domain_container",
                "value": [
                  {
                    "id": "default_constructor_field_pack_domain_group",
                    "value": false,
                    "label": "Pack site/domain"
                  },
                  {
                    "id": "default_constructor_field_pack_domain_operation",
                    "value": "3",
                    "choices": [
                      {
                        "id": "3",
                        "label": "Contains"
                      },
                      {
                        "id": "4",
                        "label": "Does not contain"
                      }
                    ]
                  },
                  {
                    "id": "default_constructor_field_pack_domain",
                    "value": null
                  }
                ]
              }
            ],
            "label": "Packs"
          }
        ]
      },
      {
        "id": "currency_converter",
        "fields": [
          {
            "id": "convert_currency_to_field",
            "value": "-1",
            "choices": [
              {
                "id": "-1",
                "label": "In transaction currency"
              },
              {
                "id": "1",
                "label": "US dollar"
              },
              {
                "id": "2",
                "label": "Russian ruble"
              },
              {
                "id": "3",
                "label": "Euro"
              }
            ]
          }
        ]
      }
    ]
  },
  "result": "ok"
}