{"components":{"schemas":{"AbsoluteDate":{"description":"Absolute date with YYYY-MM-DD format.","example":{"date":"2018-01-01"},"properties":{"date":{"format":"date","type":"string"}},"required":["date"],"type":"object"},"Analysis":{"description":"An analysis that can contain one or more queries. The \"id\" is a string field that can be used by the client to identify the analysis (although it's not used by the server for any special purpose). \"visualization_attributes\" is a dictionary that also can be used by the client for storing meta information for visualization purposes, but doesn't change anything in the data processing in the server.","example":{"id":"some-analysis","queries":[{"entity":{"region":"us","sector_id":1},"filters":[{"expression":"bixdemo_age2 > 1"}],"id":"some-simple-query","metrics_score_types":{"buzz":"net_score"},"period":{"end_date":{"days":5},"start_date":{"days":8}}},{"confidence_bound":{"percent":95,"type":"upper"},"entity":{"brand_id":1007,"region":"us","sector_id":1},"filters":[],"id":"some-complex-query","metrics_score_types":{"buzz":"net_score","wom":"negatives_neutrals"},"moving_average":3,"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"resample":{"size":2,"type":"calendar_day"},"scoring":"total"}],"title":"My Analysis"},"properties":{"created_at":{"format":"date-time","nullable":true,"type":"string"},"has_market_scanner":{"type":"boolean"},"id":{"nullable":true,"type":"string"},"is_listed":{"type":"boolean"},"is_public":{"type":"boolean"},"queries":{"items":{"$ref":"#/components/schemas/AnalysisQuery"},"type":"array"},"resource_meta":{"$ref":"#/components/schemas/ResourceMeta","nullable":true},"title":{"nullable":true,"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"visualization_attributes":{"$ref":"#/components/schemas/VisualizationAttributes","nullable":true}},"required":["queries"],"type":"object"},"AnalysisBrand":{"additionalProperties":false,"description":"One particular brand.","example":{"brand_id":1001,"region":"us","sector_id":1},"properties":{"brand_id":{"format":"int32","type":"integer"},"region":{"type":"string"},"sector_id":{"format":"int32","type":"integer"}},"required":["brand_id","sector_id","region"],"type":"object"},"AnalysisCompositeFilter":{"description":"A composite filter with its responses.","nullable":true,"properties":{"responses":{"items":{"format":"uuid","type":"string"},"type":"array"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid","responses"],"type":"object"},"AnalysisCustomSector":{"additionalProperties":false,"description":"A custom sector.","properties":{"custom_sector_uuid":{"format":"uuid","type":"string"},"is_median":{"type":"boolean"},"is_unweighted":{"type":"boolean"}},"required":["custom_sector_uuid"],"type":"object"},"AnalysisCustomSectorAllBrands":{"additionalProperties":false,"description":"A custom sector expanded into its composing brands.","properties":{"brands_from_custom_sector_uuid":{"format":"uuid","type":"string"},"only_active":{"type":"boolean"}},"required":["brands_from_custom_sector_uuid"],"type":"object"},"AnalysisDemographicFilter":{"description":"A demographic filter with its values. Although not exposed in the specification, it needs a \"values\" field containing a single integer or a list of integers.","nullable":true,"properties":{"name":{"type":"string"},"op":{"$ref":"#/components/schemas/FilterOp"}},"required":["name"],"type":"object"},"AnalysisEventsResponse":{"description":"List of events for an analysis.","properties":{"data":{"items":{"$ref":"#/components/schemas/Event"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"AnalysisExport":{"description":"This is an export of an analysis.","example":{"analysis":{"id":"some-analysis","queries":[{"entity":{"region":"us","sector_id":1},"filters":[{"expression":"bixdemo_age2 > 1"}],"id":"some-simple-query","metrics_score_types":{"buzz":"net_score"},"period":{"end_date":{"days":5},"start_date":{"days":8}}},{"confidence_bound":{"percent":95,"type":"upper"},"entity":{"brand_id":1007,"region":"us","sector_id":1},"filters":[],"id":"some-complex-query","metrics_score_types":{"buzz":"net_score","wom":"negatives_neutrals"},"moving_average":3,"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"resample":{"size":2,"type":"calendar_day"},"scoring":"total"}],"title":"My Analysis"},"force_daily":false,"format":"excel"},"properties":{"analysis":{"$ref":"#/components/schemas/Analysis"},"force_daily":{"type":"boolean"},"format":{"$ref":"#/components/schemas/ExportFormat"}},"required":["analysis"],"type":"object"},"AnalysisExportRequest":{"description":"This is the request for an analysis export.","example":{"data":{"analysis":{"id":"some-analysis","queries":[{"entity":{"region":"us","sector_id":1},"filters":[{"expression":"bixdemo_age2 > 1"}],"id":"some-simple-query","metrics_score_types":{"buzz":"net_score"},"period":{"end_date":{"days":5},"start_date":{"days":8}}},{"confidence_bound":{"percent":95,"type":"upper"},"entity":{"brand_id":1007,"region":"us","sector_id":1},"filters":[],"id":"some-complex-query","metrics_score_types":{"buzz":"net_score","wom":"negatives_neutrals"},"moving_average":3,"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"resample":{"size":2,"type":"calendar_day"},"scoring":"total"}],"title":"My Analysis"},"force_daily":false,"format":"excel"},"meta":{"version":"v1"}},"properties":{"data":{"$ref":"#/components/schemas/AnalysisExport"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"AnalysisIndustry":{"additionalProperties":false,"description":"An industry.","properties":{"industry_uuid":{"format":"uuid","type":"string"},"is_median":{"type":"boolean"},"is_unweighted":{"type":"boolean"}},"required":["industry_uuid"],"type":"object"},"AnalysisIndustryAllBrands":{"additionalProperties":false,"description":"An industry expanded into its composing brands.","properties":{"brands_from_industry_uuid":{"format":"uuid","type":"string"},"only_active":{"type":"boolean"}},"required":["brands_from_industry_uuid"],"type":"object"},"AnalysisListResponse":{"description":"This is a response that represents an list of analyses.","properties":{"data":{"items":{"$ref":"#/components/schemas/Analysis"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"AnalysisMetricFilter":{"description":"A metric filter. Although not exposed in the specification, it needs a \"values\" field containing a single integer or a list of integers.","nullable":true,"properties":{"brand_id":{"format":"int32","nullable":true,"type":"integer"},"metric":{"$ref":"#/components/schemas/MetricFilter"},"op":{"$ref":"#/components/schemas/FilterOp"}},"required":["metric"],"type":"object"},"AnalysisProfilesFilter":{"description":"A Profiles filter with its values. The definition_name must be composed by <dataseries>__<definition> - e.g. \"profiles_us__age\". Although not exposed in the specification, it needs a \"values\" field containing a single string or a list of strings.","nullable":true,"properties":{"definition_name":{"type":"string"},"op":{"$ref":"#/components/schemas/FilterOp"}},"required":["definition_name"],"type":"object"},"AnalysisQuery":{"additionalProperties":true,"description":"One single query inside an analysis. It corresponds to a series in a chart, for example.","example":{"confidence_bound":{"percent":95,"type":"upper"},"entity":{"brand_id":1007,"region":"us","sector_id":1},"filters":[],"id":"some-complex-query","metrics_score_types":{"buzz":"net_score","wom":"negatives_neutrals"},"moving_average":3,"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"resample":{"size":2,"type":"calendar_day"},"scoring":"total"},"properties":{"confidence_bound":{"$ref":"#/components/schemas/ConfidenceBound","nullable":true},"entity":{"description":"An entity that will be represented in the query. If an entity with \"AllBrands\" is used, it will be expanded to one resulting query per brand, generating multiple queries as the outcome of an analysis execution.","oneOf":[{"$ref":"#/components/schemas/AnalysisBrand"},{"$ref":"#/components/schemas/AnalysisSector"},{"$ref":"#/components/schemas/AnalysisCustomSector"},{"$ref":"#/components/schemas/AnalysisIndustry"},{"$ref":"#/components/schemas/AnalysisSectorAllBrands"},{"$ref":"#/components/schemas/AnalysisCustomSectorAllBrands"},{"$ref":"#/components/schemas/AnalysisIndustryAllBrands"}]},"filters":{"description":"A list of filters to use in the query. Each item in the list must be one of the possible types of filters (they can be mixed in the list), and they're applied in the query with the \"AND\" logic (all filters are applied), but each value in a filter is applied with the \"OR\" logic within the context of that same filter.","items":{"oneOf":[{"$ref":"#/components/schemas/FilterExpression"},{"$ref":"#/components/schemas/AnalysisDemographicFilter"},{"$ref":"#/components/schemas/AnalysisProfilesFilter"},{"$ref":"#/components/schemas/AnalysisMetricFilter"},{"$ref":"#/components/schemas/AnalysisCompositeFilter"}]},"type":"array"},"id":{"description":"An optional string that can be used by the client to identify each query in an analysis.","nullable":true,"type":"string"},"is_market_scanner":{"description":"Read-only. Whether the query is related to a Market Scanner subscription or not.","type":"boolean"},"metrics_score_types":{"additionalProperties":{"$ref":"#/components/schemas/ScoreType"},"description":"A mapping to define which score type to use for each metric desired in the query.","type":"object"},"moving_average":{"description":"The moving average (AKA \"rolling mean\") that should be applied to the query execution. Leading dates are also used to calculate the datapoint of the start date of the query.","format":"int32","type":"integer"},"period":{"description":"The period for which the data should be fetched. The moving average doesn't affect the start of the period, although it does get used for calculating the first datapoint as well.","oneOf":[{"$ref":"#/components/schemas/BinaryPeriod"},{"$ref":"#/components/schemas/OffsetPeriod"}]},"properties_meta":{"$ref":"#/components/schemas/AnalysisQueryPropertiesMeta","description":"Read-only. Properties usable to get labels applicable to properties of this query.","nullable":true},"resample":{"$ref":"#/components/schemas/Frequency","nullable":true},"scoring":{"$ref":"#/components/schemas/Scoring"},"title":{"description":"An optional string to represent the title of the analysis.","nullable":true,"type":"string"},"uuid":{"description":"Read-only. If coming from a saved analysis, it represents the UUID of the query.","format":"uuid","nullable":true,"type":"string"},"validated_filter_expression":{"nullable":true,"type":"string"},"visualization_attributes":{"additionalProperties":true,"description":"Read-only. Special attributes defined by the UI for visualization purposes.","nullable":true,"type":"object"}},"required":["entity","period","filters","metrics_score_types"],"type":"object"},"AnalysisQueryPropertiesMeta":{"description":"Metadata for analyses queries","nullable":true,"properties":{"entity":{"oneOf":[{"$ref":"#/components/schemas/EntityPropertyMeta"},{"$ref":"#/components/schemas/ObjectError"}]},"filters":{"items":{"oneOf":[{"$ref":"#/components/schemas/FilterExpressionDefinition"},{"$ref":"#/components/schemas/DemographicFilterDefinition"},{"$ref":"#/components/schemas/MetricFilterDefinition"},{"$ref":"#/components/schemas/ProfilesDefinition"},{"$ref":"#/components/schemas/CompositeFilter"},{"$ref":"#/components/schemas/ObjectError"}]},"type":"array"}},"required":["entity"],"type":"object"},"AnalysisQueryResult":{"description":"This is a processing result for one query inside an analysis. It contains the data processed by the server as a result for doing the analyses themselves.","properties":{"data":{"additionalProperties":true,"type":"object"},"entity":{"oneOf":[{"$ref":"#/components/schemas/AnalysisBrand"},{"$ref":"#/components/schemas/AnalysisSector"},{"$ref":"#/components/schemas/AnalysisCustomSector"},{"$ref":"#/components/schemas/AnalysisIndustry"}]},"id":{"nullable":true,"type":"string"},"last_day_with_data":{"format":"date","type":"string"},"last_period_is_complete":{"type":"boolean"},"periods":{"items":{"$ref":"#/components/schemas/Period"},"nullable":true,"type":"array"},"query_index":{"format":"int32","type":"integer"}},"required":["data","entity","query_index"],"type":"object"},"AnalysisRequest":{"description":"This is a request that represents an analysis, and it can be used to execute the analysis itself on the server.","example":{"data":{"id":"some-analysis","queries":[{"entity":{"region":"us","sector_id":1},"filters":[{"expression":"bixdemo_age2 > 1"}],"id":"some-simple-query","metrics_score_types":{"buzz":"net_score"},"period":{"end_date":{"days":5},"start_date":{"days":8}}},{"confidence_bound":{"percent":95,"type":"upper"},"entity":{"brand_id":1007,"region":"us","sector_id":1},"filters":[],"id":"some-complex-query","metrics_score_types":{"buzz":"net_score","wom":"negatives_neutrals"},"moving_average":3,"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"resample":{"size":2,"type":"calendar_day"},"scoring":"total"}],"title":"My Analysis"},"meta":{"version":"v1"}},"properties":{"data":{"$ref":"#/components/schemas/Analysis"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"AnalysisResponse":{"description":"This is a response that represents an analysis, and it can be used to describe the analysis and its properties.","properties":{"data":{"$ref":"#/components/schemas/Analysis"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"AnalysisResult":{"description":"This is a processing result for an analysis that contains one or more queries results.","properties":{"id":{"nullable":true,"type":"string"},"queries":{"items":{"$ref":"#/components/schemas/AnalysisQueryResult"},"type":"array"}},"required":["queries"],"type":"object"},"AnalysisResultResponse":{"description":"This is the response for an analysis result.","properties":{"data":{"$ref":"#/components/schemas/AnalysisResult"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"AnalysisSector":{"additionalProperties":false,"description":"A whole sector.","properties":{"is_median":{"type":"boolean"},"is_unweighted":{"type":"boolean"},"region":{"type":"string"},"sector_id":{"format":"int32","type":"integer"}},"required":["sector_id","region"],"type":"object"},"AnalysisSectorAllBrands":{"additionalProperties":false,"description":"A sector expanded into its composing brands.","properties":{"brands_from_sector_id":{"format":"int32","type":"integer"},"only_active":{"type":"boolean"},"region":{"type":"string"}},"required":["brands_from_sector_id","region"],"type":"object"},"Author":{"properties":{"email":{"type":"string"},"first_name":{"nullable":true,"type":"string"},"last_name":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid","email"],"type":"object"},"BinaryPeriod":{"description":"Period with a start and an end date.","example":{"end_date":{"days":5},"start_date":{"date":"2018-01-01"}},"properties":{"end_date":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteDate"},{"$ref":"#/components/schemas/RelativeDate"}]},"start_date":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteDate"},{"$ref":"#/components/schemas/RelativeDate"}]}},"required":["start_date","end_date"],"type":"object"},"Brand":{"description":"Brand with its overall properties.","properties":{"id":{"format":"int32","type":"integer"},"is_active":{"type":"boolean"},"label":{"nullable":true,"type":"string"},"region":{"type":"string"},"sector_id":{"format":"int32","type":"integer"},"validity_periods":{"items":{"$ref":"#/components/schemas/Period"},"nullable":true,"type":"array"}},"required":["id","region","sector_id"],"type":"object"},"BrandsResponse":{"properties":{"data":{"additionalProperties":{"$ref":"#/components/schemas/Brand"},"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"CompositeFilter":{"description":"This is a composite filter.","example":{"label":"Age","region_name":"us","responses":[{"expression":"age in [1]","label":"Under age","uuid":null}],"uuid":null},"properties":{"created_at":{"format":"date-time","nullable":true,"type":"string"},"is_listed":{"type":"boolean"},"is_public":{"type":"boolean"},"label":{"type":"string"},"region_name":{"type":"string"},"resource_meta":{"$ref":"#/components/schemas/ResourceMeta","nullable":true},"responses":{"items":{"$ref":"#/components/schemas/CompositeFilterResponse"},"type":"array"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"valid_in_sectors":{"items":{"format":"int32","type":"integer"},"nullable":true,"type":"array"}},"required":["label","region_name","responses"],"type":"object"},"CompositeFilterRequestResponse":{"description":"This is a request that represents a composite filter along with its possible responses.","example":{"data":{"label":"Age","region_name":"us","responses":[{"expression":"age in [1]","label":"Under age","uuid":null}],"uuid":null},"meta":{"version":"v1"}},"properties":{"data":{"$ref":"#/components/schemas/CompositeFilter"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"CompositeFilterResponse":{"description":"This is one possible response from a composite filter.","example":{"expression":"age in [1]","label":"Under age","uuid":null},"properties":{"expression":{"type":"string"},"label":{"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["label","expression"],"type":"object"},"CompositeFiltersResponse":{"description":"This is a response with a list of composite filters.","example":{"data":[{"label":"Age","region_name":"us","responses":[{"expression":"age in [1]","label":"Under age","uuid":null}],"uuid":null}],"meta":{"version":"v1"}},"properties":{"data":{"items":{"$ref":"#/components/schemas/CompositeFilter"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ConfidenceBound":{"description":"A confidence bound to apply to all calculated values. The type can be \"upper\" or \"lower\", and the percent can be any integer between 1 and 99.","nullable":true,"properties":{"percent":{"format":"int32","type":"integer"},"type":{"$ref":"#/components/schemas/ConfidenceBoundType"}},"required":["type","percent"],"type":"object"},"ConfidenceBoundType":{"description":"The confidence bound type, if \"upper\" or \"lower\".","enum":["upper","lower"],"type":"string"},"CustomSector":{"properties":{"brands":{"items":{"$ref":"#/components/schemas/Brand"},"type":"array"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"has_market_scanner":{"type":"boolean"},"is_listed":{"type":"boolean"},"is_public":{"type":"boolean"},"label":{"type":"string"},"resource_meta":{"$ref":"#/components/schemas/ResourceMeta","nullable":true},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["label","brands"],"type":"object"},"CustomSectorRequestResponse":{"description":"Successful request or response body schema for custom sector.","properties":{"data":{"$ref":"#/components/schemas/CustomSector"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"CustomSectorsResponse":{"description":"Successful response body schema for custom sectors.","properties":{"data":{"items":{"$ref":"#/components/schemas/CustomSector"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"Datapoint":{"properties":{"date":{"format":"date","type":"string"},"metric":{"$ref":"#/components/schemas/Metric"},"negatives":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]},"negatives_neutrals":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]},"neutrals":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]},"positives":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]},"positives_neutrals":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]},"score":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]},"volume":{"oneOf":[{"format":"float","type":"number"},{"format":"int32","type":"integer"}]}},"required":["metric","date","volume","score","positives","negatives","neutrals","positives_neutrals","negatives_neutrals"],"type":"object"},"DemographicFilterDefinition":{"description":"Demographic filter definition, will all its possible values.","properties":{"label":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"valid_in_sectors":{"items":{"format":"int32","type":"integer"},"type":"array"},"values":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["name","label","type","valid_in_sectors","values"],"type":"object"},"DemographicFiltersResponse":{"description":"Successful response for getting demographic filters definitions.","properties":{"data":{"additionalProperties":{"$ref":"#/components/schemas/DemographicFilterDefinition"},"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"EntityPropertyMeta":{"properties":{"description":{"oneOf":[{"$ref":"#/components/schemas/Brand"},{"$ref":"#/components/schemas/Sector"},{"$ref":"#/components/schemas/CustomSector"}]},"regions":{"additionalProperties":{"$ref":"#/components/schemas/RegionPropertyMeta"},"type":"object"}},"required":["description","regions"],"type":"object"},"EntitySearchResponse":{"description":"Successful response for searching for entities.","properties":{"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/SearchBrand"},{"$ref":"#/components/schemas/SearchSector"},{"$ref":"#/components/schemas/SearchCustomSector"}]},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"Event":{"description":"Event.","properties":{"contexts":{"items":{"$ref":"#/components/schemas/EventContext"},"type":"array"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"date":{"format":"date","type":"string"},"description":{"nullable":true,"type":"string"},"end_date":{"format":"date","nullable":true,"type":"string"},"is_global":{"type":"boolean"},"is_listed":{"type":"boolean"},"is_public":{"type":"boolean"},"label":{"type":"string"},"resource_meta":{"$ref":"#/components/schemas/ResourceMeta","nullable":true},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["label","date","contexts"],"type":"object"},"EventContext":{"description":"Event context.","properties":{"brand_id":{"format":"int32","nullable":true,"type":"integer"},"metric":{"$ref":"#/components/schemas/Metric","nullable":true},"region":{"nullable":true,"type":"string"},"sector_id":{"format":"int32","nullable":true,"type":"integer"}},"type":"object"},"EventResponse":{"description":"Response for an event.","properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"EventsResponse":{"description":"Successful response for list of events.","properties":{"data":{"items":{"$ref":"#/components/schemas/Event"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ExportFormat":{"enum":["excel","csv"],"type":"string"},"File":{"description":"File content","format":"binary","type":"string"},"FilterExpression":{"description":"A filter expression. It uses the same syntax as the composite filters responses. **Only use this if you know what you're doing, as the syntax can be tricky**.","nullable":true,"properties":{"expression":{"type":"string"}},"required":["expression"],"type":"object"},"FilterExpressionDefinition":{"description":"This is a definition for a filter expression.","example":{"expression":"foo == 1"},"properties":{"expression":{"type":"string"}},"required":["expression"],"type":"object"},"FilterOp":{"description":"The operators supported in filter definitions.","enum":["==","in",">",">=","<","<="],"type":"string"},"Frequency":{"description":"A frequency, normally used for resampling data in periods. If the data should be resampled to 2-month chunks, you can use a Frequency of size \"2\" and of type \"month_end\", for example.","nullable":true,"properties":{"size":{"format":"int32","type":"integer"},"type":{"$ref":"#/components/schemas/FrequencyType"}},"required":["size","type"],"type":"object"},"FrequencyType":{"description":"A type of frequency. The types that end in \"_from_day\" define periods congruent to a start date, when it's defined. For example, if an analysis is done from 2018-01-15 to 2018-12-15, using \"month_from_day\" will set the first period from 2018-01-15 until 2018-02-14, the second from 2018-02-15 to 2018-03-14 and so on.","enum":["match_period","business_day","calendar_day","weekly","month_end","semi_month_end","business_month_end","month_start","month_from_day","semi_month_start","semi_month_from_day","business_month_start","quarter_end","business_quarter_end","quarter_start","quarter_from_day","business_quarter_start","year_end","business_year_end","year_start","year_from_day","business_year_start"],"type":"string"},"IndustriesResponse":{"description":"Successful request or response body schema for industries.","properties":{"data":{"items":{"$ref":"#/components/schemas/Industry"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"Industry":{"description":"An industry with possible children industries","example":{"children":[{"label":"Software Development"},{"label":"Software Testing"}],"label":"Information Technology"},"properties":{"brands":{"items":{"$ref":"#/components/schemas/Brand"},"type":"array"},"children":{"items":{"$ref":"#/components/schemas/Industry"},"type":"array"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"label":{"type":"string"},"parent_uuid":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["label"],"type":"object"},"IndustryRequestResponse":{"description":"Successful request or response body schema for industry.","properties":{"data":{"$ref":"#/components/schemas/Industry"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"JSONErrorResponse":{"description":"Error schema","example":{"error_code":123,"extra":{"foo":"bar"},"message":"Something went wrong","request_id":"1234-abcd"},"properties":{"error_code":{"format":"int32","type":"integer"},"extra":{"additionalProperties":true,"type":"object"},"message":{"type":"string"},"request_id":{"type":"string"}},"required":["message","error_code"],"type":"object"},"Meta":{"description":"Metadata for any request and response to and from the server. Currently only the version is included.","example":{"version":"v1"},"properties":{"version":{"type":"string"}},"required":["version"],"type":"object"},"Metric":{"description":"One of the available metrics to use in analyses.","enum":["index","buzz","impression","quality","value","reputation","satisfaction","recommend","aided","attention","adaware","wom","consider","likelybuy","current_own","former_own"],"example":"buzz","type":"string"},"MetricFilter":{"description":"A metric filter.","enum":["quality","buzz","customer_status","reputation","impression","consider","value","adaware","recommend","satisfaction","wom","aided","likelybuy"],"example":"buzz","type":"string"},"MetricFilterDefinition":{"description":"Definition of a metric filter, with all its possible values.","properties":{"label":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/MetricFilterType"},"values":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["name","label","type","values"],"type":"object"},"MetricFilterType":{"description":"The type of a metric filter, which affects which options can be chosen for filtering analyses queries.","enum":["categorical","binary","awareness","customer_status"],"type":"string"},"MetricFiltersResponse":{"description":"Successful response for getting metric filters.","properties":{"data":{"additionalProperties":{"$ref":"#/components/schemas/MetricFilterDefinition"},"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ObjectError":{"description":"Object error schema","properties":{"extra":{"additionalProperties":true,"type":"object"},"reason":{"type":"string"}},"required":["reason"],"type":"object"},"OffsetPeriod":{"description":"Period normally representing a sentence, like \"last week\" etc. The example here means \"last month\". Can receive an \"adjust_by\" relative date to push the period forward.","example":{"amount":1,"offset":1,"starting_month":1,"type":"month"},"properties":{"adjust_by":{"$ref":"#/components/schemas/RelativeDate","nullable":true},"amount":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"starting_month":{"format":"int32","type":"integer"},"starting_weekday":{"$ref":"#/components/schemas/WeekDay"},"type":{"$ref":"#/components/schemas/PeriodType"}},"required":["type","offset","amount"],"type":"object"},"OperationResponse":{"description":"Simple response for operations that don't return usable data.","properties":{"data":{"type":"boolean"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"Period":{"description":"Period with start and end dates","example":{"end_date":"2020-12-31","start_date":"2020-01-01"},"properties":{"end_date":{"format":"date","nullable":true,"type":"string"},"start_date":{"format":"date","nullable":true,"type":"string"}},"type":"object"},"PeriodType":{"description":"The period type, from \"week\", \"month\" etc.","enum":["day","week","semi_month","month","quarter","semi_year","year"],"example":"month","type":"string"},"ProfilesCategoriesAndDefinitions":{"description":"Profiles subcategories and definitions that are available inside a Profiles category.","properties":{"definitions":{"items":{"$ref":"#/components/schemas/ProfilesPartialDefinition"},"type":"array"},"subcategories":{"items":{"type":"string"},"type":"array"}},"required":["subcategories","definitions"],"type":"object"},"ProfilesCategoriesRequest":{"description":"Successful request for Profiles categories.","properties":{"data":{"items":{"type":"string"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ProfilesCategoriesResponse":{"description":"Successful response for Profiles categories and definitions.","properties":{"data":{"$ref":"#/components/schemas/ProfilesCategoriesAndDefinitions"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ProfilesDataseries":{"description":"A dataseries and its definitions, including languages it's avalailable to.","properties":{"languages":{"items":{"$ref":"#/components/schemas/ProfilesDataseriesLanguage"},"type":"array"},"name":{"type":"string"}},"required":["name","languages"],"type":"object"},"ProfilesDataseriesLanguage":{"description":"A language used in dataseries.","properties":{"code":{"type":"string"}},"required":["code"],"type":"object"},"ProfilesDataseriesResponse":{"description":"Successful response for Profiles dataseries lists.","properties":{"data":{"items":{"$ref":"#/components/schemas/ProfilesDataseries"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ProfilesDefinition":{"description":"A Profiles definition with its codes and categories where it's available at.","properties":{"categories":{"items":{"type":"string"},"nullable":true,"type":"array"},"codes":{"items":{"$ref":"#/components/schemas/ProfilesDefinitionCode"},"nullable":true,"type":"array"},"description":{"nullable":true,"type":"string"},"label":{"type":"string"},"language":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["name","label","language","type"],"type":"object"},"ProfilesDefinitionCode":{"description":"Code for Profiles definitions.","properties":{"name":{"type":"string"},"value":{"oneOf":[{"type":"string"},{"format":"int32","type":"integer"}]}},"required":["name","value"],"type":"object"},"ProfilesDefinitionResponse":{"description":"Successful response for a specific Profiles definition.","properties":{"data":{"$ref":"#/components/schemas/ProfilesDefinition"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ProfilesDefinitionsResponse":{"description":"Successful response for Profiles definitions.","properties":{"data":{"items":{"$ref":"#/components/schemas/ProfilesPartialDefinition"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"ProfilesPartialDefinition":{"description":"A simpler form of a Profiles definition.","properties":{"label":{"type":"string"},"name":{"type":"string"}},"required":["name","label"],"type":"object"},"RankSignificanceDiff":{"properties":{"down":{"format":"float","type":"number"},"percentage":{"format":"int32","type":"integer"},"up":{"format":"float","type":"number"}},"type":"object"},"RankedEntity":{"properties":{"comparison_position":{"$ref":"#/components/schemas/RankingPosition","nullable":true},"days_with_score":{"format":"int32","type":"integer"},"entity":{"oneOf":[{"$ref":"#/components/schemas/AnalysisBrand"},{"$ref":"#/components/schemas/AnalysisSector"},{"$ref":"#/components/schemas/AnalysisCustomSector"},{"$ref":"#/components/schemas/AnalysisIndustry"}]},"last_day_with_data":{"format":"date","nullable":true,"type":"string"},"position":{"$ref":"#/components/schemas/RankingPosition"},"position_change":{"$ref":"#/components/schemas/RankingPosition","nullable":true},"rank_significance_diffs":{"items":{"$ref":"#/components/schemas/RankSignificanceDiff"},"nullable":true,"type":"array"},"trend":{"format":"int32","type":"integer"}},"required":["entity"],"type":"object"},"Ranking":{"additionalProperties":true,"description":"A ranking definition for later execution. The \"id\" is a string field that can be used by the client to identify the ranking.","example":{"comparison_period":{"end_date":{"days":15},"start_date":{"date":"2018-11-25"}},"entities":[{"brand_id":1007,"region":"us","sector_id":1},{"brand_id":1011,"region":"us","sector_id":1}],"filters":[],"id":"some-ranking","metrics_score_types":{"buzz":"net_score","wom":"negatives"},"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"scoring":"total","significance_percentages":[95,90],"title":"Some Ranking"},"properties":{"comparison_period":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/BinaryPeriod"},{"$ref":"#/components/schemas/OffsetPeriod"}]},"created_at":{"format":"date-time","nullable":true,"type":"string"},"entities":{"items":{"oneOf":[{"$ref":"#/components/schemas/AnalysisBrand"},{"$ref":"#/components/schemas/AnalysisSector"},{"$ref":"#/components/schemas/AnalysisCustomSector"},{"$ref":"#/components/schemas/AnalysisIndustry"},{"$ref":"#/components/schemas/AnalysisSectorAllBrands"},{"$ref":"#/components/schemas/AnalysisCustomSectorAllBrands"},{"$ref":"#/components/schemas/AnalysisIndustryAllBrands"}]},"type":"array"},"filters":{"items":{"oneOf":[{"$ref":"#/components/schemas/FilterExpression"},{"$ref":"#/components/schemas/AnalysisDemographicFilter"},{"$ref":"#/components/schemas/AnalysisProfilesFilter"},{"$ref":"#/components/schemas/AnalysisMetricFilter"},{"$ref":"#/components/schemas/AnalysisCompositeFilter"}]},"type":"array"},"id":{"nullable":true,"type":"string"},"is_listed":{"type":"boolean"},"is_market_scanner":{"type":"boolean"},"is_public":{"type":"boolean"},"metrics_score_types":{"additionalProperties":{"$ref":"#/components/schemas/ScoreType"},"type":"object"},"period":{"oneOf":[{"$ref":"#/components/schemas/BinaryPeriod"},{"$ref":"#/components/schemas/OffsetPeriod"}]},"properties_meta":{"$ref":"#/components/schemas/RankingPropertiesMeta","nullable":true},"resource_meta":{"$ref":"#/components/schemas/ResourceMeta","nullable":true},"scoring":{"$ref":"#/components/schemas/Scoring"},"significance_percentages":{"items":{"format":"int32","type":"integer"},"nullable":true,"type":"array"},"title":{"nullable":true,"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"visualization_attributes":{"additionalProperties":true,"nullable":true,"type":"object"}},"required":["period","scoring","filters","entities","metrics_score_types"],"type":"object"},"RankingExport":{"description":"This is an export of a ranking.","example":{"format":"excel","ranking":{"comparison_period":{"end_date":{"days":15},"start_date":{"date":"2018-11-25"}},"entities":[{"brand_id":1007,"region":"us","sector_id":1},{"brand_id":1011,"region":"us","sector_id":1}],"filters":[],"id":"some-ranking","metrics_score_types":{"buzz":"net_score","wom":"negatives"},"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"scoring":"total","significance_percentages":[95,90],"title":"Some Ranking"}},"properties":{"format":{"$ref":"#/components/schemas/ExportFormat"},"ranking":{"$ref":"#/components/schemas/Ranking"}},"required":["ranking"],"type":"object"},"RankingExportRequest":{"description":"This is the request for a ranking export.","example":{"data":{"format":"excel","ranking":{"comparison_period":{"end_date":{"days":15},"start_date":{"date":"2018-11-25"}},"entities":[{"brand_id":1007,"region":"us","sector_id":1},{"brand_id":1011,"region":"us","sector_id":1}],"filters":[],"id":"some-ranking","metrics_score_types":{"buzz":"net_score","wom":"negatives"},"period":{"end_date":{"days":5},"start_date":{"date":"2018-12-25"}},"scoring":"total","significance_percentages":[95,90],"title":"Some Ranking"}},"meta":{"version":"v1"}},"properties":{"data":{"$ref":"#/components/schemas/RankingExport"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"RankingListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Ranking"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"RankingPosition":{"properties":{"rank":{"format":"int32","type":"integer"},"score":{"format":"float","type":"number"},"volume":{"format":"float","type":"number"}},"type":"object"},"RankingPropertiesMeta":{"description":"Metadata for analyses queries","nullable":true,"properties":{"entities":{"items":{"oneOf":[{"$ref":"#/components/schemas/EntityPropertyMeta"},{"$ref":"#/components/schemas/ObjectError"}]},"type":"array"},"filters":{"items":{"oneOf":[{"$ref":"#/components/schemas/FilterExpressionDefinition"},{"$ref":"#/components/schemas/DemographicFilterDefinition"},{"$ref":"#/components/schemas/MetricFilterDefinition"},{"$ref":"#/components/schemas/ProfilesDefinition"},{"$ref":"#/components/schemas/CompositeFilter"},{"$ref":"#/components/schemas/ObjectError"}]},"type":"array"}},"type":"object"},"RankingRequest":{"properties":{"data":{"$ref":"#/components/schemas/Ranking"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"RankingResponse":{"properties":{"data":{"$ref":"#/components/schemas/Ranking"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"RankingResultResponse":{"properties":{"data":{"additionalProperties":{"items":{"$ref":"#/components/schemas/RankedEntity"},"type":"array"},"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"Region":{"description":"Region with name and possible label.","properties":{"has_market_scanner":{"type":"boolean"},"label":{"nullable":true,"type":"string"},"name":{"type":"string"},"permitted":{"nullable":true,"type":"boolean"}},"required":["name"],"type":"object"},"RegionPropertyMeta":{"properties":{"description":{"$ref":"#/components/schemas/Region"},"sectors":{"additionalProperties":{"$ref":"#/components/schemas/SectorPropertyMeta"},"type":"object"}},"required":["description","sectors"],"type":"object"},"RegionsResponse":{"description":"Successful response for regions.","properties":{"data":{"additionalProperties":{"$ref":"#/components/schemas/Region"},"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"RelativeDate":{"additionalProperties":false,"description":"How many days, weeks, months and/or years ago.","example":{"days":5},"minProperties":1,"properties":{"days":{"format":"int32","type":"integer"},"months":{"format":"int32","type":"integer"},"weeks":{"format":"int32","type":"integer"},"years":{"format":"int32","type":"integer"}},"type":"object"},"Resource":{"properties":{"object_id":{"format":"uuid","type":"string"},"object_type":{"$ref":"#/components/schemas/ResourceType"}},"required":["object_type","object_id"],"type":"object"},"ResourceMeta":{"description":"Metadata for resource-like entities","nullable":true,"properties":{"author":{"$ref":"#/components/schemas/Author","nullable":true},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["tags"],"type":"object"},"ResourceType":{"enum":["Analysis","CompositeFilter","CustomSector","Dashboard","BrandDashboard","Event","Ranking","Report"],"type":"string"},"ScoreType":{"description":"The score type to use. \"net_score\" means both positives and negatives and neutrals affect the score. \"positives\" means only positives count, negatives and neutrals are discarded. \"negatives\" means only negatives count. \"neutrals\" means only neutrals count. \"positives_neutrals\" means positives and neutrals count. \"negatives_neutrals\" means negatives and neutrals count.","enum":["net_score","positives","negatives","neutrals","positives_neutrals","negatives_neutrals"],"example":"net_score","type":"string"},"Scoring":{"description":"The scoring population to use. \"total\" means it uses all the population. \"aware\" means it excludes unaware respondents. \"opinion\" means it excludes unaware and neutral respondents.","enum":["total","aware","opinion"],"example":"total","type":"string"},"SearchBrand":{"description":"Brand with its overall properties.","properties":{"id":{"format":"int32","type":"integer"},"is_active":{"type":"boolean"},"label":{"nullable":true,"type":"string"},"region":{"type":"string"},"sector":{"$ref":"#/components/schemas/SearchSector","nullable":true},"sector_id":{"format":"int32","type":"integer"},"validity_periods":{"items":{"$ref":"#/components/schemas/Period"},"nullable":true,"type":"array"}},"required":["id","region","sector_id"],"type":"object"},"SearchCustomSector":{"properties":{"brands":{"items":{"$ref":"#/components/schemas/SearchBrand"},"type":"array"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"has_market_scanner":{"type":"boolean"},"label":{"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid","label","brands"],"type":"object"},"SearchSector":{"description":"Sector with region and possible label.","properties":{"id":{"format":"int32","type":"integer"},"industry_label":{"type":"string"},"industry_uuid":{"format":"uuid","nullable":true,"type":"string"},"is_active":{"type":"boolean"},"is_market_scanner":{"type":"boolean"},"label":{"type":"string"},"region":{"type":"string"}},"required":["id","region","label","is_active"],"type":"object"},"Sector":{"description":"Sector with region and possible label.","properties":{"id":{"format":"int32","type":"integer"},"industry_label":{"type":"string"},"industry_uuid":{"format":"uuid","nullable":true,"type":"string"},"is_active":{"type":"boolean"},"is_market_scanner":{"type":"boolean"},"label":{"type":"string"},"region":{"type":"string"}},"required":["id","region","label","is_active"],"type":"object"},"SectorGuessResponse":{"description":"Successful response for sector ID.","properties":{"data":{"format":"int32","type":"integer"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"SectorPropertyMeta":{"properties":{"brands":{"additionalProperties":{"$ref":"#/components/schemas/Brand"},"type":"object"},"description":{"$ref":"#/components/schemas/Sector"}},"required":["description","brands"],"type":"object"},"SectorResponse":{"description":"Successful response body schema for sector.","properties":{"data":{"$ref":"#/components/schemas/Sector"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"SectorsResponse":{"description":"Successful response body schema for sectors.","properties":{"data":{"additionalProperties":{"$ref":"#/components/schemas/Sector"},"type":"object"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"SignificanceDiff":{"description":"This is a significance difference object for all score types. 1 means there was a significant change to higher value. -1 means significantly lower value. 0 means no change.","example":{"alias":"sig-test-one","negatives":0,"negatives_neutrals":-1,"neutrals":0,"positives":0,"positives_neutrals":0,"score":0},"properties":{"alias":{"nullable":true,"type":"string"},"negatives":{"format":"int32","type":"integer"},"negatives_neutrals":{"format":"int32","type":"integer"},"neutrals":{"format":"int32","type":"integer"},"positives":{"format":"int32","type":"integer"},"positives_neutrals":{"format":"int32","type":"integer"},"score":{"format":"int32","type":"integer"}},"type":"object"},"SignificanceTest":{"example":{"alias":"sig-test-one","baseline_datapoint":{"date":"2018-01-01","metric":"buzz","negatives":7.697242,"negatives_neutrals":80.122693,"neutrals":72.425451,"positives":11.213957,"positives_neutrals":83.639408,"score":3.516715,"volume":505.9999},"metric":"buzz","percent":95,"test_datapoint":{"date":"2018-01-01","metric":"buzz","negatives":6.878556,"negatives_neutrals":74.629909,"neutrals":67.751353,"positives":11.813346,"positives_neutrals":79.564699,"score":4.93479,"volume":520.99998}},"properties":{"alias":{"nullable":true,"type":"string"},"baseline_datapoint":{"$ref":"#/components/schemas/Datapoint"},"granular_metrics_datapoints":{"additionalProperties":{"$ref":"#/components/schemas/SignificanceTestDatapointPair"},"type":"object"},"metric":{"$ref":"#/components/schemas/Metric"},"percent":{"format":"int32","type":"integer"},"test_datapoint":{"$ref":"#/components/schemas/Datapoint"}},"required":["metric","percent","baseline_datapoint","test_datapoint"],"type":"object"},"SignificanceTestDatapointPair":{"example":{"baseline":{"date":"2018-01-01","metric":"impression","negatives":7.697242,"negatives_neutrals":80.122693,"neutrals":72.425451,"positives":11.213957,"positives_neutrals":83.639408,"score":3.516715,"volume":505.9999},"test":{"date":"2018-01-01","metric":"impression","negatives":6.878556,"negatives_neutrals":74.629909,"neutrals":67.751353,"positives":11.813346,"positives_neutrals":79.564699,"score":4.93479,"volume":520.99998}},"properties":{"baseline":{"$ref":"#/components/schemas/Datapoint"},"test":{"$ref":"#/components/schemas/Datapoint"}},"required":["baseline","test"],"type":"object"},"SignificanceTestRequest":{"description":"This is the request for a significance test.","example":{"data":{"alias":"sig-test-one","baseline_datapoint":{"date":"2018-01-01","metric":"buzz","negatives":7.697242,"negatives_neutrals":80.122693,"neutrals":72.425451,"positives":11.213957,"positives_neutrals":83.639408,"score":3.516715,"volume":505.9999},"metric":"buzz","percent":95,"test_datapoint":{"date":"2018-01-01","metric":"buzz","negatives":6.878556,"negatives_neutrals":74.629909,"neutrals":67.751353,"positives":11.813346,"positives_neutrals":79.564699,"score":4.93479,"volume":520.99998}},"meta":{"version":"v1"}},"properties":{"data":{"$ref":"#/components/schemas/SignificanceTest"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"SignificanceTestResponse":{"description":"This is the response for a significance test.","example":{"data":{"alias":"sig-test-one","negatives":0,"negatives_neutrals":-1,"neutrals":0,"positives":0,"positives_neutrals":0,"score":0},"meta":{"version":"v1"}},"properties":{"data":{"$ref":"#/components/schemas/SignificanceDiff"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"SignificanceTestsRequest":{"description":"This is the request for batch significance tests.","example":{"data":[{"alias":"sig-test-one","baseline_datapoint":{"date":"2018-01-01","metric":"buzz","negatives":7.697242,"negatives_neutrals":80.122693,"neutrals":72.425451,"positives":11.213957,"positives_neutrals":83.639408,"score":3.516715,"volume":505.9999},"metric":"buzz","percent":95,"test_datapoint":{"date":"2018-01-01","metric":"buzz","negatives":6.878556,"negatives_neutrals":74.629909,"neutrals":67.751353,"positives":11.813346,"positives_neutrals":79.564699,"score":4.93479,"volume":520.99998}}],"meta":{"version":"v1"}},"properties":{"data":{"items":{"$ref":"#/components/schemas/SignificanceTest"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"SignificanceTestsResponse":{"description":"This is the response for batch significance tests.","example":{"data":[{"alias":"sig-test-one","negatives":0,"negatives_neutrals":-1,"neutrals":0,"positives":0,"positives_neutrals":0,"score":0}],"meta":{"version":"v1"}},"properties":{"data":{"items":{"$ref":"#/components/schemas/SignificanceDiff"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"StringResponse":{"description":"Just a simple response with a string.","properties":{"data":{"type":"string"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"Tag":{"properties":{"label":{"type":"string"},"user_uuid":{"format":"uuid","nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"visualization_attributes":{"additionalProperties":true,"nullable":true,"type":"object"}},"required":["label"],"type":"object"},"TagResourcesResponse":{"description":"This is a response that represents resources for a tag","properties":{"data":{"items":{"$ref":"#/components/schemas/Resource"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"TagResponse":{"description":"This is a response that represents a tag","properties":{"data":{"$ref":"#/components/schemas/Tag"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"TagsResponse":{"description":"This is a response that represents a list of tags","properties":{"data":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"UserCredentials":{"description":"Credentials from a user.","properties":{"email":{"type":"string"},"password":{"type":"string"}},"required":["email","password"],"type":"object"},"UserCredentialsRequest":{"description":"A request to get authenticated user by their credentials.","properties":{"data":{"$ref":"#/components/schemas/UserCredentials"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["meta","data"],"type":"object"},"VisualizationAttributes":{"description":"A dictionary with possible visualization attributes. Only `type` is validated, the rest of the attributes are open.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/VisualizationAttributesType"}},"required":["type"],"type":"object"},"VisualizationAttributesType":{"enum":["time","scorecard","snapshot","rankings"],"type":"string"},"WeekDay":{"description":"The weekday, like \"monday\", \"tuesday\" etc.","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"example":"wednesday","type":"string"}}},"info":{"title":"API","version":"v1"},"openapi":"3.0.1","paths":{"/v1/analyses":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"query","name":"is_listed","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisListResponse"}}},"description":"This is a response that represents an list of analyses."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all analyses.","tags":["analyses"]},"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}},"description":"This is a request that represents an analysis, and it can be used to execute the analysis itself on the server.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisResponse"}}},"description":"This is a response that represents an analysis, and it can be used to describe the analysis and its properties."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Creates an analysis.","tags":["analyses"]}},"/v1/analyses/events":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}},"description":"This is a request that represents an analysis, and it can be used to execute the analysis itself on the server.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisEventsResponse"}}},"description":"List of events for an analysis."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets events for an analysis.","tags":["analyses"]}},"/v1/analyses/events/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"UUID of the analysis to consider","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisEventsResponse"}}},"description":"List of events for an analysis."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets events for an analysis.","tags":["analyses"]}},"/v1/analyses/execute":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}},"description":"This is a request that represents an analysis, and it can be used to execute the analysis itself on the server.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisResultResponse"}}},"description":"This is the response for an analysis result."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute an analysis based on its definition.","tags":["analyses"]}},"/v1/analyses/execute.{format}":{"post":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"format","required":true,"schema":{"enum":["csv"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}},"description":"This is a request that represents an analysis, and it can be used to execute the analysis itself on the server.","required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/File"}}},"description":"File content"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute an analysis with specific formatting.","tags":["analyses"]}},"/v1/analyses/execute/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisResultResponse"}}},"description":"This is the response for an analysis result."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute an analysis based on its UUID.","tags":["analyses"]}},"/v1/analyses/execute/{uuid}.{format}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"","in":"path","name":"format","required":true,"schema":{"enum":["csv"],"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/File"}}},"description":"File content"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute an analysis based on its UUID.","tags":["analyses"]}},"/v1/analyses/export":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisExportRequest"}}},"description":"This is the request for an analysis export.","required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/File"}}},"description":"File content"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Export an analysis based on its definition.","tags":["analyses"]}},"/v1/analyses/significance-test":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignificanceTestRequest"}}},"description":"This is the request for a significance test.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignificanceTestResponse"}}},"description":"This is the response for a significance test."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Runs a significance test and return the result.","tags":["analyses"]}},"/v1/analyses/significance-tests":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignificanceTestsRequest"}}},"description":"This is the request for batch significance tests.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignificanceTestsResponse"}}},"description":"This is the response for batch significance tests."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Runs a batch of significance tests and returns the results.","tags":["analyses"]}},"/v1/analyses/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"UUID of the analysis to get","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisResponse"}}},"description":"This is a response that represents an analysis, and it can be used to describe the analysis and its properties."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets an analysis with its definition.","tags":["analyses"]}},"/v1/auth/login":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCredentialsRequest"}}},"description":"A request to get authenticated user by their credentials.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}},"description":"Simple response for operations that don't return usable data."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Logs a user in.","tags":["auth"]}},"/v1/events":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"query","name":"is_listed","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsResponse"}}},"description":"Successful response for list of events."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all events.","tags":["events"]}},"/v1/events/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"UUID of the event to get","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"description":"Response for an event."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets an event.","tags":["events"]}},"/v1/filters/composite":{"get":{"deprecated":false,"description":"","parameters":[{"description":"The region to list filters for","in":"query","name":"region_name","required":false,"schema":{"type":"string"}},{"description":"If provided, returns composite filters with the specified listed status (true/false)","in":"query","name":"is_listed","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompositeFiltersResponse"}}},"description":"This is a response with a list of composite filters."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists composite filters.","tags":["filters"]}},"/v1/filters/composite/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"UUID of the filter to get","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompositeFilterRequestResponse"}}},"description":"This is a request that represents a composite filter along with its possible responses."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets a composite filter.","tags":["filters"]}},"/v1/filters/demos/{region}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicFiltersResponse"}}},"description":"Successful response for getting demographic filters definitions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all demographic filters within region.","tags":["filters"]}},"/v1/filters/metric":{"get":{"deprecated":false,"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricFiltersResponse"}}},"description":"Successful response for getting metric filters."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all metric filters.","tags":["filters"]}},"/v1/filters/profiles/categories/{dataseries}":{"post":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"dataseries","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesCategoriesRequest"}}},"description":"Successful request for Profiles categories.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesCategoriesResponse"}}},"description":"Successful response for Profiles categories and definitions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all Profiles filter sub-categories for a certain dataseries, in any level of the category tree.","tags":["filters"]}},"/v1/filters/profiles/dataseries":{"get":{"deprecated":false,"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesDataseriesResponse"}}},"description":"Successful response for Profiles dataseries lists."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all Profiles filter dataseries.","tags":["filters"]}},"/v1/filters/profiles/definition/{dataseries}/{definition_name}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"dataseries","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"definition_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesDefinitionResponse"}}},"description":"Successful response for a specific Profiles definition."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets a Profiles filter definition.","tags":["filters"]}},"/v1/filters/profiles/search/{dataseries}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"dataseries","required":true,"schema":{"type":"string"}},{"description":"A name or part of name to query for Profiles filters definitions","in":"query","name":"q","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesDefinitionsResponse"}}},"description":"Successful response for Profiles definitions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Searches for Profiles filter definitions.","tags":["filters"]}},"/v1/question-texts/{region_name}/{sector_id}/{metric}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"region_name","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"sector_id","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"","in":"path","name":"metric","required":true,"schema":{"description":"One of the available metrics to use in analyses.","enum":["index","buzz","impression","quality","value","reputation","satisfaction","recommend","aided","attention","adaware","wom","consider","likelybuy","current_own","former_own"],"example":"buzz","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringResponse"}}},"description":"Just a simple response with a string."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets a question text.","tags":["question_texts"]}},"/v1/rankings":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"query","name":"is_listed","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingListResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all rankings.","tags":["rankings"]}},"/v1/rankings/execute":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingRequest"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingResultResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute ranking based on its definition.","tags":["rankings"]}},"/v1/rankings/execute.{format}":{"post":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"format","required":true,"schema":{"enum":["csv"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingRequest"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingResultResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute ranking with specific format.","tags":["rankings"]}},"/v1/rankings/execute/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingResultResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute ranking based on its UUID.","tags":["rankings"]}},"/v1/rankings/execute/{uuid}.{format}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"","in":"path","name":"format","required":true,"schema":{"enum":["csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingResultResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Execute ranking based on its UUID as specified format.","tags":["rankings"]}},"/v1/rankings/export":{"post":{"deprecated":false,"description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingExportRequest"}}},"description":"This is the request for a ranking export.","required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/File"}}},"description":"File content"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Export a ranking based on its definition.","tags":["rankings"]}},"/v1/rankings/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"UUID of the ranking to get","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RankingResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets a ranking.","tags":["rankings"]}},"/v1/system/health":{"get":{"deprecated":false,"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}},"description":"Simple response for operations that don't return usable data."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Checks system responsiveness.","tags":["system"]}},"/v1/tags":{"get":{"deprecated":false,"description":"","parameters":[{"description":"If provided, list all tags for this resource uuid","in":"query","name":"resource_uuid","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"If provided, list all tags for this resource object_type","in":"query","name":"resource_object_type","required":false,"schema":{"type":"string"}},{"description":"If provided, list all tags for this resource object_id","in":"query","name":"resource_object_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsResponse"}}},"description":"This is a response that represents a list of tags"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"List all tags for user.","tags":["tags"]}},"/v1/tags/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponse"}}},"description":"This is a response that represents a tag"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Get tag for user.","tags":["tags"]}},"/v1/tags/{uuid}/resources":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourcesResponse"}}},"description":"This is a response that represents resources for a tag"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Get resources for a tag.","tags":["tags"]}},"/v1/taxonomies/custom-sectors":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"query","name":"is_listed","required":false,"schema":{"type":"boolean"}},{"description":"Deprecated, do not use","in":"query","name":"describe_brands","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSectorsResponse"}}},"description":"Successful response body schema for custom sectors."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all custom sectors.","tags":["taxonomies"]}},"/v1/taxonomies/custom-sectors/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"UUID of the custom sector to get","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Deprecated, do not use","in":"query","name":"describe_brands","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSectorRequestResponse"}}},"description":"Successful request or response body schema for custom sector."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets a custom sector.","tags":["taxonomies"]}},"/v1/taxonomies/industries/trees/{region}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"The region where the industry trees should be fetched from","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"Deprecated, do not use","in":"query","name":"describe_brands","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndustriesResponse"}}},"description":"Successful request or response body schema for industries."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists industry trees.","tags":["taxonomies"]}},"/v1/taxonomies/industries/trees/{region}/{uuid}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"The region where the industry tree should be fetched from","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"The UUID of the industry tree root to get","in":"path","name":"uuid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Deprecated, do not use","in":"query","name":"describe_brands","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndustryRequestResponse"}}},"description":"Successful request or response body schema for industry."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Gets an industry tree.","tags":["taxonomies"]}},"/v1/taxonomies/regions":{"get":{"deprecated":false,"description":"","parameters":[{"description":"If truthy, return all regions, otherwise, just user ones","in":"query","name":"all","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionsResponse"}}},"description":"Successful response for regions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all regions.","tags":["taxonomies"]}},"/v1/taxonomies/regions/{region}/custom-sectors":{"get":{"deprecated":false,"description":"","parameters":[{"description":"The region to fetch custom sectors for","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"Deprecated, do not use","in":"query","name":"describe_brands","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSectorsResponse"}}},"description":"Successful response body schema for custom sectors."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all custom sectors for a given region.","tags":["taxonomies"]}},"/v1/taxonomies/regions/{region}/guess_sector_for/{brand_id}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"brand_id","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectorGuessResponse"}}},"description":"Successful response for sector ID."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Guesses the sector ID for a certain brand ID in a certain region.","tags":["taxonomies"]}},"/v1/taxonomies/regions/{region}/sector/{sector_id}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"sector_id","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectorResponse"}}},"description":"Successful response body schema for sector."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Describes a sector.","tags":["taxonomies"]}},"/v1/taxonomies/regions/{region}/sectors":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectorsResponse"}}},"description":"Successful response body schema for sectors."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all sectors within region.","tags":["taxonomies"]}},"/v1/taxonomies/regions/{region}/sectors/{sector_id}/brands":{"get":{"deprecated":false,"description":"","parameters":[{"description":"","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"sector_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandsResponse"}}},"description":""},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Lists all brands within sector ID and region.","tags":["taxonomies"]}},"/v1/taxonomies/search/{type}":{"get":{"deprecated":false,"description":"","parameters":[{"description":"The type of entity to search for","in":"path","name":"type","required":true,"schema":{"description":"Whether a search should be done by brand or sector or custom sector or all.","enum":["all","brands","sectors","custom_sectors"],"type":"string"}},{"description":"The string to search for","in":"query","name":"q","required":true,"schema":{"type":"string"}},{"description":"The region to search in","in":"query","name":"region","required":false,"schema":{"type":"string"}},{"description":"The minimum similarity to return results for (1.0 is a perfect match)","in":"query","name":"min_similarity","required":false,"schema":{"format":"float","type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySearchResponse"}}},"description":"Successful response for searching for entities."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONErrorResponse"}}},"description":"Error schema"}},"summary":"Returns the entity results matching the provided query.","tags":["taxonomies"]}}},"tags":[{"description":"Handle data for analyses.","name":"analyses"},{"description":"Handle authentication and authorization.","name":"auth"},{"description":"Handle data for events.","name":"events"},{"description":"Handle data for filters.","name":"filters"},{"description":"Question texts.","name":"question_texts"},{"description":"Handle data for rankings.","name":"rankings"},{"description":"System management.","name":"system"},{"description":"Handle data for tags.","name":"tags"},{"description":"Handle data for taxonomies.","name":"taxonomies"}]}