Lytics API v2

{"components":{"schemas":{"lioerrors.ApiV2ErrorOut":{"properties":{"code":{"description":"Lytics Error Code","enum":["UNKNOWN-000","BADREQ-001","JOB-BADREQ-002","NOTFOUND-003","JOB-NOTFOUND-004","WF-NOTFOUND-005","AUTH-NOTFOUND-006","AUTHTYPE-NOTFOUND-007","AUTH-BADREQ-008","TABLE-NOTFOUND-009","SCHEMA-NOTFOUND-010","SCHEMAVERSION-NOTFOUND-011","ENTITY-NOTFOUND-012","QUERY-NOTFOUND-013","STREAM-NOTFOUND-014","PROVIDER-BADREQ-015","PROVIDER-NOTFOUND-016","UNAUTHORIZED-017","SCHEMA-INVALID-018","INTERNAL-019","ROUTERULE-NOTFOUND-020","ACCOUNT-NOTFOUND-021","JOB-FAULT-022","USER-NOTFOUND-023","USER-BADREQ-024","JSON-BADREQ-025","FORBIDDEN-026"],"type":"string"},"level":{"description":"When the error was generated","type":"string"},"message":{"description":"A description of the error that occurred","type":"string"},"timestamp":{"description":"The time the error occurred","format":"date-time","type":"string"}},"type":"object"},"models.AccountCreateRequest":{"properties":{"allow_pathora":{"type":"boolean"},"allowed_login_methods":{"type":"string"},"archive_retention_duration":{"type":"string"},"default_es_cluster":{"type":"string"},"description":{"type":"string"},"domain":{"type":"string"},"email":{"type":"string"},"expires":{"type":"string"},"feat_conductor_schema":{"type":"boolean"},"features":{"additionalProperties":true,"type":"object"},"fid":{"type":"string"},"github_path":{"type":"string"},"google_marketplace_private_quote_name":{"type":"string"},"has_active_campaign":{"type":"boolean"},"lytics_warehouse":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"packages":{"additionalProperties":{"type":"string"},"type":"object"},"partner_id":{"type":"string"},"pubusers":{"type":"boolean"},"roles":{"items":{"type":"string"},"type":"array"},"salesforce_id":{"description":"Settings","type":"string"},"settings":{"additionalProperties":true,"type":"object"},"silo":{"type":"string"},"sso_connections":{"type":"string"},"sso_provider_id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"models.AccountResp":{"properties":{"aid":{"type":"integer"},"billing_organization_id":{"type":"string"},"created":{"type":"string"},"created_by_user_id":{"type":"string"},"deleted":{"type":"boolean"},"description":{"type":"string"},"domain":{"type":"string"},"email":{"type":"string"},"entitlement_plans":{"items":{"$ref":"#/components/schemas/models.EntitlementPlan"},"type":"array"},"entity":{},"expires":{"type":"string"},"features":{"additionalProperties":true,"type":"object"},"fid":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"packages":{"additionalProperties":{"type":"string"},"type":"object"},"parent_id":{"type":"string"},"parentaid":{"type":"integer"},"partner_id":{"type":"string"},"partner_slug":{"type":"string"},"permanent":{"type":"boolean"},"provider_id":{"type":"string"},"pubusers":{"type":"boolean"},"roles_available":{"items":{"$ref":"#/components/schemas/models.RolePolicy"},"type":"array"},"status":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"timezone":{"type":"string"},"two_factor_auth":{"type":"boolean"},"type":{"type":"string"},"updated":{"type":"string"}},"type":"object"},"models.AccountUpdateRequest":{"properties":{"billing_organization_id":{"type":"string"},"description":{"type":"string"},"domain":{"type":"string"},"email":{"type":"string"},"fid":{"type":"string"},"name":{"type":"string"},"partner_id":{"type":"string"},"partner_slug":{"type":"string"},"pubusers":{"type":"boolean"},"settings":{"additionalProperties":true,"type":"object"},"settings_delete":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"tags_delete":{"items":{"type":"string"},"type":"array"},"timezone":{"type":"string"}},"type":"object"},"models.AdhocTemplateTestRequest":{"properties":{"entity":{"additionalProperties":true,"type":"object"},"job_config":{"additionalProperties":true,"type":"object"},"sample_segments":{"$ref":"#/components/schemas/models.SampleSegmentsInput"},"template_definition":{"description":"Adhoc template definition","type":"string"},"template_type":{"description":"Adhoc template type","enum":["jsonnet","handlebars"],"type":"string"}},"type":"object"},"models.AdrollSync":{"properties":{"advertisable":{"description":"Adroll advertisable ID","type":"string"},"continuous":{"description":"Select to continuously sync all audiences to AdRoll every 24 hours","type":"boolean"},"pixel":{"description":"AdRoll pixel ID","type":"string"}},"type":"object"},"models.AdwordsCustomerMatch":{"properties":{"ad_consent":{"description":"Select the consent status for sending user data to Google for advertising purposes. Different consent groups should be sent through separate jobs to the same list","type":"string"},"adwords_account_id":{"description":"Select which Google Ads account to create the customer match list and audience model. This has to be set to select lists from managed Google Ads accounts","type":"string"},"adwords_customer_id":{"description":"Select the managed Google Ads account associated with the account selected above. This will take precedence over the selected Google Ads account. If there is no managed Google Ads Account select the same account as above.","type":"string"},"adwords_list_id":{"description":"Select which Google Ads customer match list to append to. If no list is selected, a new customer match list will be created","type":"integer"},"app_id":{"description":"If Mobile ID is entered, enter the Mobile App ID for the mobile application from which the data was collected to AdWords API","type":"string"},"country_code_field":{"description":"Select which field contains the user's two letter country code","type":"string"},"email_field":{"description":"Select the field containing the user's email — plain or SHA256-hashed; plain values are hashed before sending.","type":"string"},"first_name_field":{"description":"Select which field contains the user's first name. To match by name, country code and zipcode must be provided","type":"string"},"last_name_field":{"description":"Select which field contains the user's last name","type":"string"},"mobile_id_field":{"description":"Select to match on mobile ID field instead of email","type":"string"},"personalization_consent":{"description":"Select consent status for ad personalization. Different consent groups should be sent through separate jobs to the same list","type":"string"},"phone_number_field":{"description":"Select the field containing the user's phone number — plain or SHA256-hashed; plain values are hashed before sending.","type":"string"},"segment_id":{"description":"Select the Lytics audience to export to Google Ads and create audience model off of","type":"string"},"user_id_field":{"description":"Select to match on user ID field instead of email","type":"string"},"zip_code_field":{"description":"Select which field contains the user's zipcode","type":"string"}},"required":["adwords_account_id"],"type":"object"},"models.AdwordsCustomerMatchMobile":{"properties":{"ad_consent":{"description":"Select the consent status for sending user data to Google for advertising purposes. Different consent groups should be sent through separate jobs to the same list","type":"string"},"adwords_account_id":{"description":"Select which Google Ads account to create the customer match list and audience model. This has to be set to select lists from managed Google Ads accounts","type":"string"},"adwords_customer_id":{"description":"Select the managed Google Ads account associated with the account selected above. This will take precedence over the selected Google Ads account. If there is no managed Google Ads Account select the same account as above.","type":"string"},"adwords_list_id":{"description":"Select which Google Ads customer match list to append to. If no list is selected, a new customer match list will be created","type":"integer"},"app_id":{"description":"If Mobile ID is entered, enter the Mobile App ID for the mobile application from which the data was collected to AdWords API","type":"string"},"mobile_id_field":{"description":"Select to match on mobile ID field instead of email","type":"string"},"personalization_consent":{"description":"Select consent status for ad personalization. Different consent groups should be sent through separate jobs to the same list","type":"string"},"segment_id":{"description":"Select the Lytics audience to export to Google Ads and create audience model off of","type":"string"}},"required":["adwords_account_id"],"type":"object"},"models.AdwordsCustomerMatchUserid":{"properties":{"ad_consent":{"description":"Select the consent status for sending user data to Google for advertising purposes. Different consent groups should be sent through separate jobs to the same list","type":"string"},"adwords_account_id":{"description":"Select which Google Ads account to create the customer match list and audience model. This has to be set to select lists from managed Google Ads accounts","type":"string"},"adwords_customer_id":{"description":"Select the managed Google Ads account associated with the account selected above. This will take precedence over the selected Google Ads account. If there is no managed Google Ads Account select the same account as above.","type":"string"},"adwords_list_id":{"description":"Select which Google Ads customer match list to append to. If no list is selected, a new customer match list will be created","type":"integer"},"personalization_consent":{"description":"Select consent status for ad personalization. Different consent groups should be sent through separate jobs to the same list","type":"string"},"segment_id":{"description":"Select the Lytics audience to export to Google Ads and create audience model off of","type":"string"},"user_id_field":{"description":"Select to match on user ID field instead of email","type":"string"}},"required":["adwords_account_id"],"type":"object"},"models.AdwordsExport":{"properties":{"accounts_are_linked":{"description":"Select if you have already linked an Google Ads account with your Analytics account. If not, [link your Google Analytics and Ads accounts](https://developers.google.com/analytics/solutions/data-import-user#link) **before** marking complete or you won't be able to send Google Ads the audiences you create with Lytics data.","type":"boolean"},"adwords_account_id":{"description":"Which account would you like to use?","type":"string"},"created_data_source":{"description":"Select if you already created a data source for Lytics to use. If not, [create a data set](https://learn.lytics.com/understanding/integrations/google/google-analytics) with only the \"Lytics User ID\" and \"Lytics Audiences\" fields **before** marking complete. When you mark complete, we'll get a list of your data sources including your new one for you to select below.","type":"boolean"},"data_source_id":{"description":"Select the data source for Lytics to use. This will be the data source you use for all future data syncs","type":"string"},"segment_id":{"description":"The name of the audience that contains the users to export","type":"string"},"web_property_id":{"description":"Which web property would you like to use?","type":"string"}},"required":["accounts_are_linked","adwords_account_id","created_data_source","data_source_id","web_property_id"],"type":"object"},"models.AirshipComplianceImport":{"properties":{"device_types":{"items":{"enum":["amazon","android","ios","web","email","sms","open"],"type":"string"},"type":"array"},"message_age":{"description":"Compliance events less than this many days old will be imported. If set to zero all compliance events will be imported. NOTE: maximum value is 90","maximum":90,"minimum":0,"type":"integer"}},"type":"object"},"models.AirshipConnect":{"properties":{"access_token":{"type":"string"},"app_key":{"type":"string"},"project_location":{"type":"string"}},"type":"object"},"models.AirshipExport":{"properties":{"commercial_optin":{"description":"Select the field that contains the date the user opted into commercial emails. This will be used to register new users in Airship. If left blank will use the current time","type":"string"},"commercial_optout":{"description":"Select the field that contains the date the user opted out of commercial emails. This will be used to register new users in Airship","type":"string"},"continuous_update":{"description":"Continuously run this export","type":"boolean"},"day_of_week":{"description":"Day of week to run work","type":"string"},"email":{"description":"Select the field that contains the user's email address. This will be used to register new users in Airship","type":"string"},"fields_mapping":{"description":"Map the Lytics fields to Airship Channel Identifiers","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"list_name":{"description":"Enter the list name you wish to create in Airship.","type":"string"},"list_url":{"description":"Select the list you want to export to, if you want to create a new list use the 'List Name' field below.","type":"string"},"run_frequency":{"description":"Choose how often a continuous export should update the list","type":"string"},"segment_id":{"description":"Choose the audience that contains the users to export.","type":"string"},"time_of_day":{"description":"Time of day to start export each day","type":"string"},"timezone":{"description":"Timezone for time of day","type":"string"},"transactional_optin":{"description":"Select the field that contains the date the user opted into transactional emails. This will be used to register new users in Airship","type":"string"},"transactional_optout":{"description":"Select the field that contains the date the user opted out of transactional emails. This will be used to register new users in Airship","type":"string"}},"type":"object"},"models.AirshipImport":{"properties":{"device_types":{"items":{"enum":["amazon","android","ios","web","email","sms","open"],"type":"string"},"type":"array"},"event_types":{"description":"Filter imported events by their type. If no event types are selected, all event types will be imported","items":{"enum":["CLOSE","CONTROL","CUSTOM","FIRST_OPEN","IN_APP_MESSAGE_DISPLAY","IN_APP_MESSAGE_EXPIRATION","IN_APP_MESSAGE_RESOLUTION","LOCATION","MOBILE_ORIGINATED","OPEN","PUSH_BODY","REGION","RICH_DELETE","RICH_DELIVERY","RICH_READ","SCREEN_VIEWED","SEND","SEND_REJECTED","SUBSCRIPTION","TAG_CHANGE","UNINSTALL","WEB_CLICK","WEB_SESSION"],"type":"string"},"type":"array"},"group_id":{"description":"Filter events by group ID. NOTE: Only one of Group ID or Push ID my be selected.","type":"string"},"message_age":{"description":"Events less than this many days old will be imported. If set to zero all events will be imported. NOTE: maximum value is 90","maximum":90,"minimum":0,"type":"integer"},"push_id":{"description":"Filter events by push ID. NOTE: Only one of Group ID or Push ID my be selected.","type":"string"}},"type":"object"},"models.AirshipMasterSecret":{"properties":{"app_key":{"type":"string"},"master_secret":{"type":"string"},"project_location":{"type":"string"}},"type":"object"},"models.AlgoliaApiKey":{"properties":{"api_key":{"description":"An API key with the search, browse and recommendation ACL permissions","type":"string"},"application_id":{"description":"Enter your Algolia application ID","type":"string"}},"type":"object"},"models.AlgoliaExport":{"properties":{"audience_events":{"description":"Select which type of audience trigger events to send to Algolia. By default both enters and exits will be sent.","enum":["enters_only","exits_only"],"type":"string"},"region":{"description":"Select your Algolia region (US or EU). Defaults to US.","enum":["us","eu"],"type":"string"},"segment_ids":{"description":"Select the audiences to export to Algolia","items":{"type":"string"},"type":"array"},"user_id_field":{"description":"Select the user field that contains the user ID to send to Algolia. Defaults to _uid.","type":"string"}},"required":["segment_ids","user_id_field"],"type":"object"},"models.AlgoliaImport":{"properties":{"continuous_update":{"description":"Continuously import updated users every hour","type":"boolean"},"start_date":{"description":"Import Algolia users from this date. If no date is selected, all users and activity data will be imported. Please use the format yyyy-mm-dd, e.g. 2021-01-25","type":"string"}},"type":"object"},"models.AmazonAdsAudienceExport":{"properties":{"ad_storage_consent":{"description":"Amazon ad storage consent status","enum":["GRANTED","DENIED","NOT_APPLICABLE","UNKNOWN"],"type":"string"},"advertiser_id":{"description":"Enter your Amazon Ads Advertiser ID","type":"string"},"country_code":{"description":"Select the 2 letter country code where the users are located","enum":["CA","DE","ES","FR","IN","IT","JP","UK","US"],"type":"string"},"external_user_id":{"description":"Select the Lytics user field that contains the external user id. If left empty, the email or phone number identifier that is mapped in identifier mapping will be used as the external user id.","type":"string"},"identifier_mapping":{"description":"Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"profile_id":{"description":"The Amazon DSP Profile/region you wish to export to","type":"string"},"segment_id":{"description":"Select the Lytics audience that contains the users to export","type":"string"},"user_data_consent":{"description":"Amazon user data consent status for Digital Markets Act compliance","enum":["GRANTED","DENIED","NOT_APPLICABLE","UNKNOWN"],"type":"string"},"withbackfill":{"description":"Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience","type":"boolean"}},"required":["advertiser_id","profile_id","segment_id"],"type":"object"},"models.AmazonAdsExportAudience":{"properties":{"ad_storage_consent":{"description":"Amazon ad storage consent status","enum":["GRANTED","DENIED","NOT_APPLICABLE","UNKNOWN"],"type":"string"},"advertiser_id":{"description":"Enter your Amazon Ads Advertiser ID","type":"string"},"country_code":{"description":"Select the 2 letter country code where the users are located","enum":["CA","DE","ES","FR","IN","IT","JP","UK","US"],"type":"string"},"external_user_id":{"description":"Select the Lytics user field that contains the external user id. If left empty, the email or phone number identifier that is mapped in identifier mapping will be used as the external user id.","type":"string"},"identifier_mapping":{"description":"Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"profile_id":{"description":"The Amazon DSP Profile/region you wish to export to","type":"string"},"segment_id":{"description":"Select the Lytics audience that contains the users to export","type":"string"},"user_data_consent":{"description":"Amazon user data consent status for Digital Markets Act compliance","enum":["GRANTED","DENIED","NOT_APPLICABLE","UNKNOWN"],"type":"string"},"withbackfill":{"description":"Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience","type":"boolean"}},"required":["advertiser_id","profile_id","segment_id"],"type":"object"},"models.AmazonCapiExport":{"properties":{"ad_storage_consent":{"description":"Amazon ad storage consent status. Required for EU countries.","enum":["","GRANTED","DENIED"],"type":"string"},"advertiser_id":{"description":"Enter your Amazon Ads Advertiser ID (DSP Advertiser ID)","type":"string"},"audience_events":{"description":"Select which type of audience trigger events to send. By default both enters and exits will be sent.","enum":["enters_only","exits_only"],"type":"string"},"conversion_type":{"description":"Select the Amazon conversion type for this event","enum":["ADD_TO_SHOPPING_CART","APPLICATION","CHECKOUT","CONTACT","LEAD","OFF_AMAZON_PURCHASES","MOBILE_APP_FIRST_START","PAGE_VIEW","SEARCH","SIGN_UP","SUBSCRIBE","OTHER"],"type":"string"},"country_code":{"description":"Select the 2 letter country code (ISO 3166-1 alpha-2). Required by Amazon for compliance.","type":"string"},"currency_code":{"description":"Enter currency code, three letter code in ISO-4217 format. Only for OFF_AMAZON_PURCHASES. If not provided, \"USD\" will be used as default","enum":["AED","AUD","BRL","CAD","CNY","EUR","GBP","INR","JPY","MXN","SAR","SEK","SGD","TRY","USD"],"type":"string"},"data_set_name":{"description":"Optional: Event Dataset Name for organizing conversion definitions","type":"string"},"event_id":{"description":"Select the Lytics user field that contains a unique event ID for deduplication","type":"string"},"event_name":{"description":"Enter the name for the event. If not provided, events will be sent with **Lytics Audiences** name","type":"string"},"event_source":{"description":"Select the platform from which the event was sourced","enum":["ANDROID","FIRE_TV","IOS","MEASUREMENT_ATTRIBUTION_PARTNER","OFFLINE","WEBSITE"],"type":"string"},"event_timestamp":{"description":"Select the Lytics user field that contains the timestamp of the event. The timestamp must not be older than 21 days. If left empty, current timestamp will be used","type":"string"},"field_changes":{"description":"Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to the Amazon Ads API.","items":{"type":"string"},"type":"array"},"identifier_mapping":{"description":"Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"segment_ids":{"description":"Select the Lytics audiences that contains the users to export","items":{"type":"string"},"type":"array"},"units_sold":{"description":"Select the Lytics user field that contains the number of units sold. Only for OFF_AMAZON_PURCHASES","type":"string"},"user_data_consent":{"description":"Amazon user data consent status. Required for EU countries.","enum":["","GRANTED","DENIED"],"type":"string"},"value":{"description":"Select the Lytics user field that contains the value of the event","type":"string"},"withbackfill":{"description":"Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience","type":"boolean"}},"required":["advertiser_id","conversion_type","identifier_mapping","segment_ids"],"type":"object"},"models.AmazonDspExport":{"properties":{"ad_storage_consent":{"description":"Consent for Amazon to read/write advertising cookies. Required for UK/EEA users.","enum":["GRANTED","DENIED"],"type":"string"},"advertiser_string":{"description":"Your Amazon DSP Advertiser ID","type":"string"},"country_codes":{"description":"Select the country codes where users in the audience live","items":{"enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string"},"type":"array"},"email_field":{"description":"Select the field containing the user's email — plain or SHA256-hashed; plain values are hashed before sending.","type":"string"},"profile_id":{"description":"The Amazon DSP Profile/region you wish to export to","type":"string"},"record_match_method":{"enum":["COOKIE","EXTERNAL_USER_ID"],"type":"string"},"segment_id":{"description":"Select the Lytics audience that contains the users to export","type":"string"},"user_data_consent":{"description":"Consent for Amazon to process personal data for advertising purposes. Required for UK/EEA users.","enum":["GRANTED","DENIED"],"type":"string"},"withbackfill":{"description":"Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience","type":"boolean"}},"required":["advertiser_string","profile_id","segment_id"],"type":"object"},"models.AmazonDspMatch":{"properties":{"address_field":{"type":"string"},"city_field":{"type":"string"},"email_field":{"description":"Select the field containing the user's email — plain or SHA256-hashed; plain values are hashed before sending.","type":"string"},"firstname_field":{"type":"string"},"lastname_field":{"type":"string"},"phone_field":{"description":"Select the field containing the user's phone number — plain or SHA256-hashed; plain values are hashed before sending","type":"string"},"profile_id":{"type":"string"},"segment_id":{"description":"Select the Lytics audience that contains the users to export","type":"string"},"state_field":{"type":"string"},"uid_field":{"type":"string"},"withbackfill":{"type":"boolean"},"zip_field":{"type":"string"}},"required":["segment_id"],"type":"object"},"models.AmazonMarketingCloudExport":{"properties":{"account":{"description":"Enter the Amazon Marketing Cloud instance to export to","type":"string"},"ad_storage_consent":{"description":"Select the Amazon ad storage consent status. This is an optional consent that sets consent status for all users in the audience for Amazon to read and/or write cookies within the customer's browser.","enum":["GRANTED","DENIED"],"type":"string"},"country_code":{"description":"Select the 2 letter country code where the users are located","enum":["CA","DE","FR","IN","IT","JP","UK","US"],"type":"string"},"dataset_id":{"description":"Enter or Select the DataSet to upload to. if left blank the audience's slug will be used","type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"identifier_mapping":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"instance":{"description":"Enter the Amazon Marketing Cloud instance to export to","type":"string"},"segment_id":{"description":"Select the Lytics audience that contains the users to export","type":"string"},"user_data_consent":{"description":"Select the Amazon user data consent status. This sets consent status for all users in the audience to use personal data for advertising purposes.","enum":["GRANTED","DENIED"],"type":"string"}},"required":["account","country_code","identifier_mapping","instance","segment_id","user_data_consent"],"type":"object"},"models.AmcExport":{"properties":{"account":{"description":"Select your Amazon Marketing Cloud account\",","type":"string"},"ad_storage_consent":{"description":"Select the Amazon ad storage consent status. This is an optional consent that sets consent status for all users in the audience for Amazon to read and/or write cookies within the customer's browser.","enum":["GRANTED","DENIED"],"type":"string"},"advertiser_id":{"description":"Enter your Amazon Ads Advertiser ID","type":"string"},"amc_instance":{"description":"If you are sending to Amazon Marketing Cloud, enter the instance ID you want the audience added to.","type":"string"},"bucket":{"type":"string"},"compress":{"type":"string"},"continuous_update":{"type":"boolean"},"country_code":{"description":"Select the 2 letter country code where the users are located","enum":["CA","DE","ES","FR","IN","IT","JP","UK","US"],"type":"string"},"dataset_id":{"type":"string"},"day_of_week":{"description":"Day of week to run work","type":"string"},"directory":{"type":"string"},"external_user_id":{"description":"Select the Lytics user field that contains the external user id. If left empty, the email or phone number identifier that is mapped in identifier mapping will be used as the external user id.","type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"filename":{"type":"string"},"filetype":{"type":"string"},"identifier_mapping":{"description":"Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"instance":{"type":"string"},"profile_id":{"description":"The Amazon DSP Profile/region you wish to export to","type":"string"},"region":{"type":"string"},"run_frequency":{"type":"string"},"segment_id":{"description":"Select the Lytics audience that contains the users to export","type":"string"},"services":{"description":"Select the Amazon service(s) to send users to","enum":["AMC","DSP"],"type":"string"},"table":{"type":"string"},"time_format":{"type":"string"},"time_of_day":{"type":"string"},"timezone":{"type":"string"},"user_data_consent":{"description":"Select the Amazon user data consent status. This sets consent status for all users in the audience to use personal data for advertising purposes.","enum":["GRANTED","DENIED"],"type":"string"},"withbackfill":{"description":"Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience","type":"boolean"},"write_headers":{"type":"boolean"}},"required":["advertiser_id","profile_id","segment_id","user_data_consent"],"type":"object"},"models.AmplitudeApiKey":{"properties":{"apikey":{"type":"string"},"apisecret":{"type":"string"}},"type":"object"},"models.AmplitudeCohortImport":{"properties":{"amplitude_id_field":{"description":"The field name that contains the user's Amplitude ID. If left blank, cohorts will only be added to profiles","type":"string"},"cohort_ids":{"description":"Select the cohorts you want to import. If left blank, all cohorts will be imported","items":{"type":"string"},"type":"array"},"continuous_update":{"description":"Import cohorts daily","type":"boolean"},"membership_by_name_field":{"description":"The field name that contains the user's cohort membership. If left blank, cohorts will only be added to profiles","type":"string"},"time_of_day":{"description":"Time of day to start import","type":"string"},"timezone":{"description":"Timezone for time of day","type":"string"}},"type":"object"},"models.AmplitudeEventImport":{"properties":{"backfill_days":{"description":"How many days in the past do you want to import events (default is 90 days). Select 0 if you want to start from now on","maximum":3600,"minimum":0,"type":"integer"},"continuous_update":{"description":"Import events hourly","type":"boolean"}},"type":"object"},"models.AnalyticsSetup":{"properties":{"adwords_account_id":{"description":"Select which Google Analytics account to use","type":"string"},"ga4":{"description":"Select whether Google Analytics 4 or Google Universal Analytics is used","type":"boolean"},"premium_account":{"description":"Check if you have a Google Analytics 360 account","type":"boolean"},"user_fields":{"description":"Select the user fields to export to Google Analytics. If none are selected, only user audience affiliation will be exported. Regular Google Analytics accounts are limited to 20 custom dimensions per property and Google Analytics 360 accounts are limited to 200. Please make sure that there is enough room in your account for the number of dimensions that you select plu

# --- truncated at 32 KB (1909 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/openapi/lytics-api-v2-openapi.json