{
"openapi": "3.0.0",
"info": {
"title": "RichAds API reference",
"description": "**Advertiser API base URL:** `https://api.richads.com/api/v2`\n**Publisher API base URL:** `https://api.richads.com/api/v3`\n**Partner API base URL:** `https://api.richads.com/api/v4`\n\nRichAds advertising platform API for managing campaigns, creatives, targeting, and statistics.\n",
"version": "2.0"
},
"paths": {
"/api/webinars/register": {
"post": {
"tags": [
"webinars"
],
"operationId": "post_api_webinars_register",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnBoardingWebinarEventRequest"
}
}
}
},
"responses": {
"201": {
"description": ""
}
}
}
},
"/api/webinars/closest": {
"get": {
"tags": [
"webinars"
],
"operationId": "get_api_webinars_nearest",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnBoardingWebinarEvent"
}
}
}
}
}
}
},
"/api/predict/cpc": {
"post": {
"tags": [
"predict"
],
"operationId": "post_predict_clicks",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CpcPredictorRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/reports": {
"get": {
"tags": [
"report"
],
"operationId": "get_api_report_list",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Get list of report items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportListResponseDTO"
}
}
}
}
}
},
"post": {
"tags": [
"report"
],
"operationId": "post_api_report_create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Get an item of report.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportItemResponseDTO"
}
}
}
}
}
}
},
"/api/reports/{id}/duplicate/parameters": {
"get": {
"tags": [
"report"
],
"operationId": "get_api_report_duplicate_parameters",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get an item of report.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportItemParametersResponseDTO"
}
}
}
}
}
}
},
"/api/reports/{id}/view": {
"get": {
"tags": [
"report"
],
"operationId": "get_api_report_view",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get an item of report.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportItemResponseDTO"
}
}
}
}
}
}
},
"/api/reports/{id}": {
"delete": {
"tags": [
"report"
],
"operationId": "delete_api_report_delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Delete report."
}
}
}
},
"/api/reports/{id}/csv/download": {
"get": {
"tags": [
"report"
],
"operationId": "get_api_report_csv_download",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get CSV file of generated report."
}
}
}
},
"/api/reports/{id}/content": {
"get": {
"tags": [
"report"
],
"operationId": "get_api_report_json_content",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get report data json"
}
}
}
},
"/api/reports/parameters": {
"get": {
"tags": [
"report"
],
"operationId": "get_api_report_parameters",
"responses": {
"200": {
"description": "Get report parameters: campaings, createives etc.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportParametersDTO"
}
}
}
}
}
}
},
"/api/campaigns/stats": {
"get": {
"operationId": "get_api_campaigns_stats",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/v1/grouped-rtbnetworks": {
"get": {
"operationId": "get_api_grouped_ssps",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupedRtbNetworksRequest"
}
}
}
},
"responses": {
"200": {
"description": "Get grouped ssp."
}
}
}
},
"/api/campaigns/predictor": {
"get": {
"operationId": "get_api_campaigns_predictor",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/stats/total": {
"get": {
"operationId": "get_api_campaigns_stats_total",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/stats/total/filtered": {
"get": {
"operationId": "get_api_campaigns_stats_filtered_total",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/{id}/dashboard/status/dismiss": {
"post": {
"operationId": "post_api_campaigns_dashboard_status_dismiss",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/{id}/dashboard/status/apply": {
"post": {
"operationId": "post_api_campaigns_dashboard_status_apply",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/{id}/update/budget": {
"post": {
"operationId": "post_api_campaign_update_budget",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d+"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/{id}/update/bid-cpa": {
"post": {
"operationId": "post_api_campaign_update_bid_cpa",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d+"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/info": {
"get": {
"tags": [
"campaign-info"
],
"operationId": "get_api_campaign_info",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignInfoRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/api/campaigns": {
"get": {
"tags": [
"campaigns_list"
],
"operationId": "get_api_campaigns_list",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignFilterRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/campaigns/{id}/targeting": {
"post": {
"operationId": "post_api_campaign_targeting_update_budget",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/third-party/campaigns": {
"post": {
"operationId": "post_third_party_campaign_list",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyApiCampaignListRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignDTO"
}
}
}
}
}
}
},
"/api/third-party/campaigns/copy": {
"post": {
"operationId": "post_third_party_campaign_copy",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyApiCampaignListRequest2"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignDTO"
}
}
}
}
}
}
},
"/api/user-channel-experience-types": {
"get": {
"tags": [
"user_channel_experience_type"
],
"operationId": "get_api_user_channel_experience_types_get_all",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserChannelTypeExperience"
}
}
}
}
}
}
}
},
"/api/v1/user/verification": {
"post": {
"tags": [
"create_user_verification"
],
"operationId": "post_api_create_user_verification",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserVerification"
}
}
}
}
}
}
},
"/api/signup/email": {
"post": {
"tags": [
"auth"
],
"operationId": "post_api_auth_signup_email_only",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JwtToken"
}
}
}
}
}
}
},
"/api/auth/google": {
"post": {
"tags": [
"auth"
],
"operationId": "post_api_auth_google_auth",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequest2"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JwtToken"
}
}
}
}
}
}
},
"/api/auth/email-password": {
"post": {
"tags": [
"auth"
],
"operationId": "post_api_auth_email_password_auth",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailPasswordAuthorizationRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JwtToken"
}
}
}
}
}
}
},
"/api/auth/api-key": {
"post": {
"tags": [
"auth"
],
"operationId": "post_api_auth_api_key_auth",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyAuthorizationRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JwtToken"
}
}
}
}
}
}
},
"/api/forgot-password/init": {
"post": {
"tags": [
"auth"
],
"operationId": "post_api_auth_forgot_password_init",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForgotPasswordInitRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/api/forgot-password/reset": {
"post": {
"tags": [
"auth"
],
"operationId": "post_api_auth_forgot_password_reset",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForgotPasswordResetRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/api/amo-listener": {
"post": {
"operationId": "post_amo_crm_listener",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaign-manager/report": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_manager_report_create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignManagerReportCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Get an item of campaign manager report.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignManagerReportItemResponseDTO"
}
}
}
}
}
}
},
"/api/campaign-manager/report/{id}/status": {
"get": {
"tags": [
"campaign_manager_report"
],
"operationId": "get_api_campaign_manager_report_status",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get a status of campaign manager report.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignManagerReportItemResponseDTO"
}
}
}
}
}
}
},
"/api/campaign-manager/report/{id}/csv/download": {
"get": {
"tags": [
"campaign_manager_report"
],
"operationId": "get_api_campaign_manager_report_csv_download",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get a csv data of campaign manager report."
}
}
}
},
"/api/campaign-manager/report/{id}": {
"get": {
"tags": [
"campaign_manager_report"
],
"operationId": "get_api_campaign_manager_report_data",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get a data of campaign manager report."
}
}
}
},
"/api/campaign-manager/report/{id}/changeItemStatus": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_report",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateReportItemsStatusRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude items by campaign manager report"
}
}
}
},
"/api/campaign-manager/report/{id}/changeItemMicrobidding": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_report_bid",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateReportItemBidListItemsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude microbidding by campaign manager report"
}
}
}
},
"/api/campaign-manager/report/{id}/deleteMicrobidding": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_delete_report_bid",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteReportItemBidListItemsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude microbidding by campaign manager report"
}
}
}
},
"/api/campaigns/{id}/update/ssps": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_ssp",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SspRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude ssp from campaign"
}
}
}
},
"/api/campaigns/{id}/update/sites": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_sites",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude sites from campaign"
}
}
}
},
"/api/campaigns/{id}/update/devices": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_devices",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevicesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude devices from campaign"
}
}
}
},
"/api/campaigns/{id}/update/oses": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_oses",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude oses from campaign"
}
}
}
},
"/api/campaigns/{id}/update/creatives": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevicesRequest2"
}
}
}
},
"responses": {
"200": {
"description": "Include/Exclude creatives from campaign"
}
}
}
},
"/api/campaigns/{id}/update/microbidding": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_update_microbdding",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BidListItemsEditRequest"
}
}
}
},
"responses": {
"200": {
"description": "Update campaign micro bidding"
}
}
}
},
"/api/campaigns/{id}/delete/microbidding": {
"post": {
"tags": [
"campaign_manager_report"
],
"operationId": "post_api_campaign_clear_microbdding",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BidListItemsDeleteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Delete campaign micro bidding item"
}
}
}
},
"/api/campaigns/{id}/update/primary-data": {
"post": {
"operationId": "post_api_campaign_manager_update_campaign_primary_data",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d+"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaigns/{id}/primary-data": {
"get": {
"operationId": "get_api_campaign_manager_get_campaign_primary_data",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d+"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/bonuses": {
"get": {
"tags": [
"country"
],
"operationId": "get_api_bonuses_get_all",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bonus"
}
}
}
}
}
}
}
},
"/api/campaign/{id}/score": {
"put": {
"operationId": "put_calculate_campaign_score",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/conversions": {
"get": {
"operationId": "get_api_conversion_types",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/trackers": {
"get": {
"operationId": "get_api_tracker_types",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/trackers/url": {
"get": {
"tags": [
"conversion-type-tracker-urls"
],
"operationId": "get_api_conversion_type_tracker_urls",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversionTypeTrackerUrl"
}
}
}
}
}
}
}
},
"/api/users/conversion-trackers": {
"put": {
"tags": [
"create-user-conversion-tracker"
],
"operationId": "put_api_create_user_conversion_tracker",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConversionTrackerRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/tracker/generate-test-url": {
"post": {
"tags": [
"create-user-tracker-test-conversion"
],
"operationId": "post_api_create_user_tracker_test_conversion",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTrackerTestConversionRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/users/conversion-tracker-test/amount": {
"get": {
"tags": [
"user-completed-tracker-test-conversion"
],
"operationId": "get_api_user_completed_tracker_test_conversion",
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/countries": {
"get": {
"tags": [
"country"
],
"operationId": "get_api_country_get_all",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoliteCountry"
}
}
}
}
}
}
}
},
"/api/creatives/messages": {
"get": {
"tags": [
"creatives-messages"
],
"operationId": "get_api_creatives_messages",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReuseCreativeMessageOrTitleDTO"
}
}
}
}
}
}
}
},
"/api/creatives/titles": {
"get": {
"tags": [
"creatives-titles"
],
"operationId": "get_api_creatives_titles",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReuseCreativeMessageOrTitleDTO"
}
}
}
}
}
}
}
},
"/api/creatives/icons": {
"get": {
"tags": [
"creatives-icons"
],
"operationId": "get_api_creatives_icons",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreativeIconsDTO"
}
}
}
}
}
}
}
},
"/api/telegram-creatives/icons": {
"get": {
"tags": [
"telegram-creatives-icons"
],
"operationId": "get_api_telegram_creatives_icons",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreativeIconsDTO"
}
}
}
}
}
}
}
},
"/api/campaigns/push/{id}/creatives": {
"put": {
"tags": [
"api_push_creatives_update"
],
"operationId": "put_api_creatives_update",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Get craetives as array.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeResponseDTO"
}
}
}
}
}
},
"post": {
"tags": [
"api_push_creatives"
],
"operationId": "post_api_push_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Get push craetives as array.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeResponseDTO"
}
}
}
}
}
}
},
"/api/campaigns/creatives/push/{id}/delete": {
"post": {
"tags": [
"api_push_creatives_delete"
],
"operationId": "post_api_push_creatives_delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Remove creative."
}
}
}
},
"/api/v1/user": {
"get": {
"tags": [
"current_user_info"
],
"operationId": "get_api_current_user_get_info",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
},
"post": {
"tags": [
"update_current_user"
],
"operationId": "post_api_update_current_user_info",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProfileRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/user/change-password": {
"post": {
"tags": [
"update_current_user_password"
],
"operationId": "post_api_update_current_user_password",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPasswordRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JwtToken"
}
}
}
}
}
}
},
"/api/user/change-settings": {
"post": {
"tags": [
"update_current_user_settings"
],
"operationId": "post_api_update_current_user_settings",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPasswordRequest2"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/users/global-block-list": {
"get": {
"tags": [
"current_user"
],
"operationId": "get_api_get_user_global_block_list",
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/users/me": {
"get": {
"tags": [
"current_user"
],
"operationId": "get_api_current_user_get",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/users/retargeting-lists": {
"get": {
"tags": [
"Retargeting lists"
],
"operationId": "get_api_retargeting_lists_list",
"responses": {
"200": {
"description": "User retargeting lists",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"itemsCount": {
"type": "integer"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"post": {
"tags": [
"Retargeting lists"
],
"operationId": "post_api_retargeting_lists_create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRetargetingListRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created list",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"itemsCount": {
"type": "integer"
},
"url": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/users/retargeting-lists/{id}": {
"delete": {
"tags": [
"Retargeting lists"
],
"operationId": "delete_api_retargeting_lists_delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d+"
}
}
],
"responses": {
"204": {
"description": "List removed"
}
}
}
},
"/api/users/view-webinar-on-demand-video": {
"post": {
"operationId": "post_user_showed_video",
"responses": {
"200": {
"description": "success"
}
}
}
},
"/api/users/view-campaign-manager-tutorial": {
"post": {
"operationId": "post_user_viewed_\u0441ampaign_manager_tutorial_video",
"responses": {
"200": {
"description": "success"
}
}
}
},
"/api/users/view-product-tour": {
"post": {
"operationId": "post_product_tour_view",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductTourRequest"
}
}
}
},
"responses": {
"200": {
"description": "success"
}
}
}
},
"/api/users/me/activation": {
"post": {
"tags": [
"current_user"
],
"operationId": "post_api_current_user_activate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivationRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/users/visit/add-funds": {
"put": {
"operationId": "put_mark_as_visited_add_funds_page",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/users/save/ga-data": {
"put": {
"operationId": "put_save_users_ga_data",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/users/activate/automatically": {
"get": {
"tags": [
"automatically_activate_user"
],
"operationId": "get_api_automatically_activate_user",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/user/vat-number/validate": {
"post": {
"tags": [
"update_and_validate_current_user_vat_number"
],
"operationId": "post_api_update_and_validate_current_user_var_number",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserVatNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/users/unification": {
"post": {
"tags": [
"unification"
],
"operationId": "post_api_test",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/api/device/manufacturers/{countryCode}": {
"get": {
"operationId": "get_device_manufacturers",
"parameters": [
{
"name": "countryCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/device/types": {
"get": {
"tags": [
"device_types"
],
"operationId": "get_api_device_types",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
}
}
}
}
},
"/api/incoming-requests/{countryCode}": {
"get": {
"operationId": "get_druid_incoming_requests",
"parameters": [
{
"name": "countryCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/campaign/{campaignId}/blocked-requests": {
"get": {
"operationId": "get_targeting_blocks",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/countries/{id}/vat-regions": {
"get": {
"operationId": "get_get_country_vat_regions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EuCountryVatRegionRate"
}
}
}
}
}
}
}
},
"/api/invoice/{id}": {
"get": {
"tags": [
"invoice"
],
"operationId": "get_api_invoice_download",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/invoice/pre-pay": {
"post": {
"tags": [
"invoice"
],
"operationId": "post_api_invoice_pre_pay",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrePayInvoiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Generate pre pay request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrePayInvoiceRequest"
}
}
}
}
}
}
},
"/api/messengers": {
"get": {
"tags": [
"messenger_type"
],
"operationId": "get_api_messengers_get_all",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessengerType2"
}
}
}
}
}
}
}
},
"/api/v1/available-notifications": {
"get": {
"tags": [
"notification"
],
"operationId": "get_api_available_notifications",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationType"
}
}
}
}
}
}
}
},
"/api/notifications/unsubscribe": {
"post": {
"tags": [
"notifications_unsubscribe"
],
"operationId": "post_api_notifications_unsubscribe",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnsubscribeNotificationsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Unsubscribe notifications"
}
}
}
},
"/api/v2/users/me": {
"get": {
"tags": [
"User"
],
"operationId": "get_api_v2_me",
"responses": {
"200": {
"description": "Returns the authenticated user's profile information.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User2"
}
}
}
}
}
}
}
},
"/api/v2/balance": {
"get": {
"tags": [
"Finance"
],
"operationId": "get_api_v2_get_balance",
"responses": {
"200": {
"description": "Returns the authenticated client balance.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponse"
}
}
}
}
}
}
},
"/api/v2/transactions": {
"get": {
"tags": [
"Finance"
],
"operationId": "get_api_v2_get_transactions",
"parameters": [
{
"name": "dateFrom",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-01-01"
}
},
{
"name": "dateTo",
"in": "query",
"description": "Max 2 months range",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-15"
}
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"deposit",
"spend"
],
"example": "deposit"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Returns billing transactions for the authenticated client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionsResponse"
}
}
}
},
"400": {
"description": "Validation failed \u2014 invalid query parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/browsers": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_get_browsers",
"responses": {
"200": {
"description": "Returns all available browsers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Browser"
}
}
}
}
}
}
}
},
"/api/v2/browser-languages/{countryIso3Code}": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_get-by-country-iso3-code",
"parameters": [
{
"name": "countryIso3Code",
"in": "path",
"description": "ISO 3166-1 alpha-3 country code",
"required": true,
"schema": {
"type": "string"
},
"example": "USA"
}
],
"responses": {
"200": {
"description": "Returns browser languages available for the specified country.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/schedule": {
"put": {
"tags": [
"Campaigns"
],
"operationId": "put_api_v2_update_schedule",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Updated campaign schedule.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchedulerResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/sources": {
"get": {
"tags": [
"Campaigns"
],
"operationId": "get_api_v2_get_campaign_sources",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"responses": {
"200": {
"description": "Returns the campaign sources: SSP IDs (list), whitelisted site IDs (whiteList), and blocked/blacklisted site IDs (blockList).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourcesWithBlockWhiteListRequestDTO"
}
}
}
},
"403": {
"description": "Access denied \u2014 campaign does not belong to the authenticated user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
},
"404": {
"description": "Campaign not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
},
"put": {
"tags": [
"Campaigns"
],
"operationId": "put_api_v2_update_ssp",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"requestBody": {
"description": "Array of SSP (supply-side platform) IDs to assign to the campaign. Replaces the entire SSP list.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"example": [
1,
5,
12
]
}
}
},
"responses": {
"200": {
"description": "Returns the updated list of SSP IDs assigned to the campaign.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"1",
"5",
"12"
]
}
}
},
"400": {
"description": "Validation failed \u2014 invalid SSP IDs.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/sources/{type}": {
"put": {
"tags": [
"Campaigns"
],
"operationId": "put_api_v2_update_source_list",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
},
{
"name": "type",
"in": "path",
"description": "Type of source list to update",
"required": true,
"schema": {
"type": "string",
"pattern": "whitelist|blocklist",
"enum": [
"whitelist",
"blocklist"
]
},
"example": "blocklist"
}
],
"requestBody": {
"description": "Array of unique 32-character site IDs to set as the blocklist (or whitelist). Replaces the entire list.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32,
"minLength": 32
}
},
"example": [
"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
"d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1"
]
}
}
},
"responses": {
"200": {
"description": "Returns the full updated list of site IDs after the operation.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32,
"minLength": 32
}
},
"example": [
"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
"d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1"
]
}
}
},
"400": {
"description": "Validation failed \u2014 e.g. duplicate IDs or IDs not exactly 32 characters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/carriers/{countryCodeAlpha3}": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_carrier_by_country",
"parameters": [
{
"name": "countryCodeAlpha3",
"in": "path",
"description": "ISO 3166-1 alpha-3 country code",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-zA-Z]{3}"
},
"example": "USA"
}
],
"responses": {
"200": {
"description": "Returns all mobile carriers for the specified country.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Carrier"
}
}
}
}
}
}
}
},
"/api/v2/cities/region/{id}": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_cities_by_region",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Region ID",
"required": true,
"schema": {
"type": "string"
},
"example": 42
}
],
"responses": {
"200": {
"description": "Returns all cities for the specified region.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoliteCity"
}
}
}
}
}
}
}
},
"/api/v2/cities/country/{countryCodeAlpha3}": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_cities_by_country",
"parameters": [
{
"name": "countryCodeAlpha3",
"in": "path",
"description": "ISO 3166-1 alpha-3 country code",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-zA-Z]{3}"
},
"example": "USA"
}
],
"responses": {
"200": {
"description": "Returns all cities for the specified country.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoliteCity"
}
}
}
}
}
}
}
},
"/api/v2/connection-type": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_get_connection_type",
"responses": {
"200": {
"description": "Returns all available connection types (WiFi, cellular, etc.).",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectionType"
}
}
}
}
}
}
}
},
"/api/v2/countries": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_country_get_all",
"responses": {
"200": {
"description": "Returns all available countries.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoliteCountry3"
}
}
}
}
}
}
}
},
"/api/v2/size": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_size_get_all",
"responses": {
"200": {
"description": "Returns all available creative sizes.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sizes"
}
}
}
}
}
}
}
},
"/api/v2/campaigns/push/creatives/{id}": {
"get": {
"tags": [
"Creatives"
],
"operationId": "get_api_v2_get_push_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"responses": {
"200": {
"description": "Returns all push creatives for the campaign.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PushCreativeResponseDTO"
}
}
}
}
}
}
},
"put": {
"tags": [
"Creatives"
],
"operationId": "put_api_v2_creatives_update",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated push creative.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeResponseDTO"
}
}
}
}
}
},
"post": {
"tags": [
"Creatives"
],
"operationId": "post_api_v2_push_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the created push creative.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCreativeResponseDTO"
}
}
}
}
}
},
"delete": {
"tags": [
"Creatives"
],
"operationId": "delete_api_push_creative_delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Creative ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 1
}
],
"responses": {
"204": {
"description": "Push creative deleted successfully."
},
"400": {
"description": "Cannot delete the last creative in a campaign.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
},
"404": {
"description": "Creative not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/pops/creatives/{id}/status/{action}": {
"put": {
"tags": [
"Creatives"
],
"operationId": "put_api_v2_creatives_change_status_pops",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Creative ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 3
},
{
"name": "action",
"in": "path",
"description": "Status action",
"required": true,
"schema": {
"type": "string",
"pattern": "activate|pause",
"enum": [
"activate",
"pause"
]
},
"example": "pause"
}
],
"responses": {
"200": {
"description": "Returns the updated creative status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityStatusResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/push/creatives/{id}/status/{action}": {
"put": {
"tags": [
"Creatives"
],
"operationId": "put_api_v2_creatives_change_status_push",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Creative ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 1
},
{
"name": "action",
"in": "path",
"description": "Status action",
"required": true,
"schema": {
"type": "string",
"pattern": "activate|pause",
"enum": [
"activate",
"pause"
]
},
"example": "pause"
}
],
"responses": {
"200": {
"description": "Returns the updated creative status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityStatusResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/pops/creatives/{id}": {
"get": {
"tags": [
"Creatives"
],
"operationId": "get_api_v2_get_pops_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"responses": {
"200": {
"description": "Returns all pops creatives for the campaign.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PopsCreativeRequestDTO"
}
}
}
}
}
}
},
"put": {
"tags": [
"Creatives"
],
"operationId": "put_api_v2_update_pops_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated pops creative.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PopsCreativeResponseDTO"
}
}
}
}
}
},
"delete": {
"tags": [
"Creatives"
],
"operationId": "delete_api_pops_creative_delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Creative ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 3
}
],
"responses": {
"204": {
"description": "Pops creative deleted successfully."
},
"400": {
"description": "Cannot delete the last creative in a campaign.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
},
"404": {
"description": "Creative not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/display/creatives/{id}": {
"get": {
"tags": [
"Creatives"
],
"operationId": "get_api_v2_get_display_creatives",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"responses": {
"200": {
"description": "Returns all display creatives for the campaign.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DisplayCreativeResponseDTO"
}
}
}
}
}
}
},
"put": {
"tags": [
"Creatives"
],
"operationId": "put_api_v2_display_creatives_update",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisplayCreativeRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated display creative.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisplayCreativeResponseDTO"
}
}
}
}
}
},
"delete": {
"tags": [
"Creatives"
],
"operationId": "delete_api_display_creative_delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Creative ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 5
}
],
"responses": {
"204": {
"description": "Display creative deleted successfully."
},
"400": {
"description": "Cannot delete the last creative in a campaign.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
},
"404": {
"description": "Creative not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/display/creatives/{id}/status/{action}": {
"put": {
"tags": [
"Creatives"
],
"operationId": "put_api_v2_display_creatives_change_status",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Creative ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 5
},
{
"name": "action",
"in": "path",
"description": "Status action",
"required": true,
"schema": {
"type": "string",
"pattern": "activate|pause",
"enum": [
"activate",
"pause"
]
},
"example": "pause"
}
],
"responses": {
"200": {
"description": "Returns the updated creative status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityStatusResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/creatives": {
"get": {
"tags": [
"Creatives"
],
"operationId": "get_api_v2_creatives_list",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"responses": {
"200": {
"description": "Returns all creatives for the campaign. Response type depends on campaign channel (push, pops, or display).",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PushCreativeResponseDTO"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PopsCreativeResponseDTO"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DisplayCreativeResponseDTO"
}
}
]
}
}
}
}
}
}
},
"/api/v2/isp/{countryCodeAlpha3}": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_isp_by_country",
"parameters": [
{
"name": "countryCodeAlpha3",
"in": "path",
"description": "ISO 3166-1 alpha-3 country code",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-zA-Z]{3}"
},
"example": "USA"
}
],
"responses": {
"200": {
"description": "Returns all ISPs for the specified country.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Isp"
}
}
}
}
}
}
}
},
"/api/v2/os": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_all",
"responses": {
"200": {
"description": "Returns all available operating systems.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/api/v2/regions/country/{countryCodeAlpha3}": {
"get": {
"tags": [
"Reference Data"
],
"operationId": "get_api_v2_regions_by_country",
"parameters": [
{
"name": "countryCodeAlpha3",
"in": "path",
"description": "ISO 3166-1 alpha-3 country code",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-zA-Z]{3}"
},
"example": "USA"
}
],
"responses": {
"200": {
"description": "Returns all regions for the specified country.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoliteRegion"
}
}
}
}
}
}
}
},
"/api/v2/sources/push/": {
"get": {
"tags": [
"SSP Sources"
],
"operationId": "get_api_v2_get_push_sources",
"responses": {
"200": {
"description": "Returns available push SSP sources.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RtbNetwork"
}
}
}
}
}
}
}
},
"/api/v2/sources/pops/": {
"get": {
"tags": [
"SSP Sources"
],
"operationId": "get_api_v2_get_pops_sources",
"responses": {
"200": {
"description": "Returns available pops SSP sources.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RtbNetwork2"
}
}
}
}
}
}
}
},
"/api/v2/sources/display/": {
"get": {
"tags": [
"SSP Sources"
],
"operationId": "get_api_v2_get_display_sources",
"responses": {
"200": {
"description": "Returns available display SSP sources.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RtbNetwork3"
}
}
}
}
}
}
}
},
"/api/v2/campaigns/targeting/{id}": {
"post": {
"tags": [
"Targeting"
],
"operationId": "post_api_v2_update_targering",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Targeting settings to update (countries, device types, etc.).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TargetingRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated targeting settings."
},
"400": {
"description": "Validation failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/targeting/{id}/advanced": {
"post": {
"tags": [
"Targeting"
],
"operationId": "post_api_v2_update_advanced_targering",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Advanced targeting settings (device manufacturers, subscriber age, etc.).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated advanced targeting settings."
}
}
}
},
"/api/v2/campaigns/targeting/{id}/advanced/carrier": {
"post": {
"tags": [
"Targeting"
],
"operationId": "post_api_v2_update_advanced-targering-carrier",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Carrier targeting settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingCarrierItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated carrier targeting settings."
}
}
}
},
"/api/v2/campaigns/targeting/{id}/advanced/os": {
"post": {
"tags": [
"Targeting"
],
"operationId": "post_api_v2_update_advanced-targering-os",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "OS targeting settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingOsItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OS targeting settings."
}
}
}
},
"/api/v2/campaigns/targeting/{id}/advanced/connection-type": {
"post": {
"tags": [
"Targeting"
],
"operationId": "post_api_v2_update_advanced-targering-connection-type",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingConnectionTypeItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated connection type targeting settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingConnectionTypeResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/targeting/advanced/browser": {
"put": {
"tags": [
"Targeting"
],
"operationId": "put_api_v2_update_advanced-targering-browser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserListItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated browser targeting list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserListResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/targeting/advanced/browser-language": {
"put": {
"tags": [
"Targeting"
],
"operationId": "put_api_v2_update_advanced-targering-language",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserLanguageListItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated browser language targeting list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserLanguageListResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/targeting/advanced/isp": {
"put": {
"tags": [
"Targeting"
],
"operationId": "put_api_v2_update_advanced-targering-isp",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingIspListItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ISP targeting list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingIspListResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/targeting/advanced/ip": {
"put": {
"tags": [
"Targeting"
],
"operationId": "put_api_v2_update_advanced-targering-ip",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingIpListItemRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated IP targeting list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedTargetingIpListResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns": {
"get": {
"tags": [
"Campaigns"
],
"operationId": "get_api_v2_get_campaigns",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "perPage",
"in": "query",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
}
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"active",
"paused"
]
}
},
{
"name": "channel",
"in": "query",
"schema": {
"type": "string",
"enum": [
"push",
"pops",
"display",
"telegram",
"xml_native"
]
}
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string",
"maxLength": 255
}
}
],
"responses": {
"200": {
"description": "Paginated campaign list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignListResponse"
}
}
}
},
"400": {
"description": "Validation failed \u2014 invalid query parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
},
"post": {
"tags": [
"Campaigns"
],
"operationId": "post_api_v2_create_campaign",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCampaignRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Campaign created. Response includes the full campaign data with sources.blockList (blocked site IDs), sources.whiteList (whitelisted site IDs), and sources.list (SSP IDs).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignCreatorResponse"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/budget": {
"patch": {
"tags": [
"Campaigns"
],
"operationId": "patch_api_v2_update_campaign_budget",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignBudgetDTO"
}
}
}
},
"responses": {
"200": {
"description": "Updated campaign budget settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignBudgetDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/bid": {
"patch": {
"tags": [
"Campaigns"
],
"operationId": "patch_api_v2_update_campaign_bid",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCampaignBidRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Updated campaign bid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCampaignBidResponseDTO"
}
}
}
},
"400": {
"description": "Validation failed \u2014 bid out of range or unsupported campaign type.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
},
"404": {
"description": "Campaign not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/stats": {
"get": {
"tags": [
"Campaigns"
],
"operationId": "get_api_v2_campaign_stats",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
},
{
"name": "dateFrom",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-01-01"
}
},
{
"name": "dateTo",
"in": "query",
"description": "Max 2 months range",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-29"
}
},
{
"name": "groupBy",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"hour",
"country",
"site-id",
"publisher-id",
"ssp-id",
"subscription-list",
"isp",
"carrier",
"os",
"browser",
"region",
"city",
"device",
"connection-type",
"browser-language"
],
"example": "date"
}
}
],
"responses": {
"200": {
"description": "Returns campaign statistics for the given date range, optionally grouped.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignStatsItem"
}
}
}
}
}
}
}
},
"/api/v2/stats": {
"get": {
"tags": [
"Campaigns"
],
"operationId": "get_api_v2_advertiser_stats",
"parameters": [
{
"name": "dateFrom",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-01-01"
}
},
{
"name": "dateTo",
"in": "query",
"description": "Max 2 months range",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-29"
}
},
{
"name": "groupBy",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"hour",
"country",
"site-id",
"publisher-id",
"ssp-id",
"subscription-list",
"isp",
"carrier",
"os",
"browser",
"region",
"city",
"device",
"connection-type",
"browser-language",
"campaign-id"
],
"example": "date"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "perPage",
"in": "query",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
}
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"active",
"paused"
]
}
},
{
"name": "channel",
"in": "query",
"schema": {
"type": "string",
"enum": [
"push",
"pops",
"display",
"telegram",
"xml_native"
]
}
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string",
"maxLength": 255
}
}
],
"responses": {
"200": {
"description": "Returns aggregated campaign statistics for the advertiser.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvertiserStatsResponse"
}
}
}
},
"400": {
"description": "Validation failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}/status/{status}": {
"put": {
"tags": [
"Campaigns"
],
"operationId": "put_api_v2_update_campaign_status",
"parameters": [
{
"name": "status",
"in": "path",
"description": "New campaign status",
"required": true,
"schema": {
"type": "string",
"pattern": "activate|pause",
"enum": [
"activate",
"pause"
]
},
"example": "pause"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated campaign status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityStatusResponseDTO"
}
}
}
}
}
}
},
"/api/v2/campaigns/{id}": {
"delete": {
"tags": [
"Campaigns"
],
"operationId": "delete_api_v2_delete_campaign",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Campaign ID",
"required": true,
"schema": {
"type": "integer"
},
"example": 12345
}
],
"responses": {
"200": {
"description": "Campaign deleted successfully.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Campaign deleted successfully"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Campaign not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
}
}
},
"/api/v3/sites": {
"get": {
"tags": [
"api_v3_sites"
],
"operationId": "get_api_sites",
"responses": {
"200": {
"description": "Sites list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"site_id": {
"type": "integer",
"example": 1
},
"site_url": {
"type": "string",
"example": "https://example.com"
},
"zones": {
"type": "array",
"items": {
"properties": {
"zone_id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"example": [
{
"zone_id": 1
},
{
"zone_id": 2
}
]
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/api/v3/stats": {
"get": {
"tags": [
"api_v3_stats"
],
"summary": "Publisher stats",
"description": "Returns publisher statistics for the given period. Optionally grouped by date, country, and/or sub_id.",
"operationId": "get_stats",
"parameters": [
{
"name": "date_from",
"in": "query",
"description": "Start date (YYYY-MM-DD). Date range cannot exceed one month.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2025-01-01"
}
},
{
"name": "date_to",
"in": "query",
"description": "End date (YYYY-MM-DD). date_to must be >= date_from; range cannot exceed one month.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2025-01-07"
}
},
{
"name": "group_by",
"in": "query",
"description": "Comma-separated groupings: date, country, sub_id",
"required": false,
"schema": {
"type": "string",
"example": "date,country,sub_id"
}
},
{
"name": "zone_id",
"in": "query",
"description": "Zone ID",
"required": true,
"schema": {
"type": "integer",
"example": 357658
}
},
{
"name": "sub_id",
"in": "query",
"description": "Sub ID",
"required": false,
"schema": {
"type": "string",
"example": "sub_123"
}
}
],
"responses": {
"200": {
"description": "Stats",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"date": {
"description": "Present when group_by includes date",
"type": "string",
"example": "2025-01-01"
},
"country": {
"description": "Present when group_by includes country",
"type": "string",
"example": "USA"
},
"sub_id": {
"description": "Present when group_by includes sub_id or macro [SUB_ID]",
"type": "string",
"example": "[SUB_ID]"
},
"zone_id": {
"description": "Present when group_by includes zone_id filter is applied",
"type": "integer",
"example": 1
},
"impressions": {
"type": "integer",
"example": 12000
},
"clicks": {
"type": "integer",
"example": 340
},
"revenue": {
"type": "number",
"example": 45.67
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Validation error (invalid dates, range > 1 month, or group_by)"
},
"502": {
"description": "Server error"
}
}
}
},
"/api/v3/direct-links/stats": {
"get": {
"tags": [
"api_v3_direct_link_stats"
],
"summary": "Direct link stats",
"description": "Returns direct link statistics for the given period. Grouped by direct link by default; optionally by country.",
"operationId": "get_direct_link_stats",
"parameters": [
{
"name": "date_from",
"in": "query",
"description": "Start date (YYYY-MM-DD). Date range cannot exceed one month.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2025-01-01"
}
},
{
"name": "date_to",
"in": "query",
"description": "End date (YYYY-MM-DD). date_to must be >= date_from; range cannot exceed one month.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2025-01-07"
}
},
{
"name": "group_by",
"in": "query",
"description": "Comma-separated groupings: direct_link, country. Defaults to direct_link.",
"required": false,
"schema": {
"type": "string",
"example": "direct_link,country"
}
},
{
"name": "direct_link_id",
"in": "query",
"description": "Filter by direct link ID",
"required": false,
"schema": {
"type": "integer",
"example": 42
}
}
],
"responses": {
"200": {
"description": "Stats",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"direct_link_id": {
"description": "Present when group_by includes direct_link",
"type": "integer",
"example": 42
},
"country": {
"description": "Present when group_by includes country",
"type": "string",
"example": "USA"
},
"impressions": {
"type": "integer",
"example": 12000
},
"accepted_clicks": {
"type": "integer",
"example": 340
},
"conversions": {
"type": "integer",
"example": 12
},
"CR": {
"type": "number",
"example": 3.53
},
"EPC": {
"type": "number",
"example": 0.1344
},
"publisher_profit": {
"type": "number",
"example": 45.67
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Validation error (invalid dates, range > 1 month, or group_by)"
},
"502": {
"description": "Server error"
}
}
}
},
"/api/v3/zones/{zoneId}/code": {
"get": {
"tags": [
"api_v3_zone_code"
],
"operationId": "get_api_v3_zone_code",
"parameters": [
{
"name": "zoneId",
"in": "path",
"description": "Zone identifier",
"required": true,
"schema": {
"type": "string",
"example": "123"
}
}
],
"responses": {
"404": {
"description": "Zone not found"
},
"200": {
"description": "Zone script or url",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"zone_id": {
"type": "integer",
"example": 123
},
"type": {
"type": "string",
"enum": [
"url",
"html"
],
"example": "html"
}
},
"type": "object",
"oneOf": [
{
"required": [
"url"
],
"properties": {
"url": {
"description": "Direct link URL (present when type = \"url\")",
"type": "string",
"example": "https://ads.example.com/"
}
},
"type": "object"
},
{
"required": [
"html"
],
"properties": {
"html": {
"description": "HTML script code (present when type = \"html\")",
"type": "string",
"example": ""
}
},
"type": "object"
}
]
}
}
}
}
}
}
}
},
"/api/v4/segments/upload": {
"post": {
"tags": [
"api_v4_segments"
],
"summary": "Upload partner CSV file (max 20 MB)",
"operationId": "post_api_v4_segment_upload",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file",
"segment"
],
"properties": {
"file": {
"description": "CSV file (max 20 MB)",
"type": "string",
"format": "binary"
},
"segment": {
"description": "Target segment ID (must belong to the authenticated user)",
"type": "integer",
"example": 456
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "File uploaded successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadPartnerCsvResponseDTO"
}
}
}
},
"400": {
"description": "Validation failed"
},
"401": {
"description": "Invalid API key"
},
"403": {
"description": "Partner segment upload is not allowed for this user"
},
"404": {
"description": "Segment not found for this user"
}
}
}
},
"/api/users/me/billing-history": {
"get": {
"tags": [
"billing"
],
"operationId": "get_api_user_billing_history",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingFilterRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/insight": {
"get": {
"tags": [
"insight"
],
"operationId": "get_api_insight",
"responses": {
"200": {
"description": ""
}
}
}
}
},
"components": {
"schemas": {
"OnBoardingWebinarEventRequest": {
"properties": {
"clickMeetingRoomId": {
"type": "integer"
}
},
"type": "object"
},
"OnBoardingWebinarEvent": {
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"default": ""
},
"clickMeetingRoomId": {
"type": "integer"
}
},
"type": "object"
},
"CpcPredictorRequest": {
"required": [
"sspList",
"countryList",
"deviceList",
"cpm",
"channel"
],
"properties": {
"sspList": {
"type": "object",
"additionalProperties": true
},
"countryList": {
"type": "object",
"additionalProperties": true
},
"deviceList": {
"type": "object",
"additionalProperties": true
},
"cpm": {
"type": "number",
"format": "float"
},
"channel": {
"type": "string"
}
},
"type": "object"
},
"ReportListRequest": {
"properties": {
"page": {
"type": "integer",
"default": 1
},
"limit": {
"type": "integer",
"default": 20
}
},
"type": "object"
},
"ReportItemResponseDTO": {
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
},
"segments": {
"type": "string"
},
"dateRange": {
"type": "string"
},
"createdAt": {
"type": "string"
}
},
"type": "object"
},
"ReportListResponseDTO": {
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportItemResponseDTO"
},
"default": []
},
"total": {
"type": "integer"
}
},
"type": "object"
},
"ReportCreateRequest": {
"required": [
"startDate",
"endDate",
"title",
"columns",
"rows"
],
"properties": {
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"title": {
"type": "string"
},
"columns": {
"type": "object",
"additionalProperties": true
},
"rows": {
"type": "object",
"additionalProperties": true
},
"filter": {
"type": "object",
"default": [],
"additionalProperties": true
}
},
"type": "object"
},
"ReportItemParametersResponseDTO": {
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
},
"type": "object"
},
"ReportParametersDTO": {
"properties": {
"campaigns": {
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"campaignNames": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"creatives": {
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"countries": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"os": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"browsers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"subscriberList": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"type": "object"
},
"GroupedRtbNetworksRequest": {
"properties": {
"inPage": {
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Campaign": {
"type": "object"
},
"CampaignInfoRequest": {
"required": [
"channel"
],
"properties": {
"channel": {
"type": "string"
},
"specializedChannel": {
"type": "string"
},
"campaign": {
"$ref": "#/components/schemas/Campaign"
},
"duplicate": {
"type": "boolean",
"default": false
}
},
"type": "object"
},
"CampaignFilterRequest": {
"required": [
"page",
"limit"
],
"properties": {
"channel": {
"type": "string"
},
"search": {
"type": "string"
},
"status": {
"type": "string"
},
"newSubscribersOnly": {
"type": "boolean"
},
"countries": {
"type": "object",
"additionalProperties": true
},
"manual": {
"type": "boolean"
},
"targetCpa": {
"type": "boolean"
},
"performanceMode": {
"type": "boolean"
},
"sortProperty": {
"type": "string",
"enum": [
"id",
"name",
"adRank"
]
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"type": "object"
},
"ThirdPartyApiCampaignListRequest": {
"required": [
"serviceName",
"apiKey"
],
"properties": {
"serviceName": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"campaignId": {
"type": "string"
}
},
"type": "object"
},
"CampaignDTO": {
"type": "object"
},
"ThirdPartyApiCampaignListRequest2": {
"type": "object"
},
"UserChannelTypeExperience": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"handle": {
"type": "string"
}
},
"type": "object"
},
"MessengerType": {
"type": "object"
},
"UserRequestDTO": {
"required": [
"name",
"messengerType",
"messengerUser"
],
"properties": {
"name": {
"type": "string",
"maxLength": 50
},
"messengerType": {
"oneOf": [
{
"$ref": "#/components/schemas/MessengerType"
}
]
},
"messengerUser": {
"type": "string",
"maxLength": 50
},
"passport": {
"type": "string",
"maxLength": 4500000
},
"bankCard": {
"type": "string",
"maxLength": 4500000
},
"selfie": {
"type": "string",
"maxLength": 4500000
}
},
"type": "object"
},
"VerificationStatus": {
"type": "object"
},
"UserVerification": {
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"messengerId": {
"type": "string"
},
"passportUrl": {
"type": "string"
},
"bankCard": {
"type": "string"
},
"selfieUrl": {
"type": "string"
},
"verificationStatus": {
"$ref": "#/components/schemas/VerificationStatus"
}
},
"type": "object"
},
"UserChannelTypeExperience2": {
"type": "object"
},
"UserRequest": {
"required": [
"email",
"password",
"messengerType",
"messengerUser",
"recaptchaToken"
],
"properties": {
"email": {
"type": "string",
"maxLength": 255
},
"password": {
"type": "string",
"maxLength": 64
},
"messengerType": {
"oneOf": [
{
"$ref": "#/components/schemas/MessengerType"
}
]
},
"messengerUser": {
"type": "string",
"maxLength": 50
},
"userChannelTypeExperience": {
"$ref": "#/components/schemas/UserChannelTypeExperience2"
},
"recaptchaToken": {
"type": "string"
},
"sourceBusterRef": {
"type": "string"
},
"invitedByUserId": {
"type": "integer"
},
"sourceBusterFull": {
"type": "object",
"additionalProperties": true
},
"userUiQueryParams": {
"type": "string"
},
"recaptchaType": {
"type": "string"
},
"isNewRegistrationPageUsed": {
"type": "boolean",
"default": false
},
"linkAccount": {
"type": "boolean",
"default": false
},
"richadsLandingType": {
"type": "string"
},
"linkApiKey": {
"type": "string"
}
},
"type": "object"
},
"user_status": {},
"VerificationStatus2": {
"properties": {
"handle": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"UserVerification2": {
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"messengerId": {
"type": "string"
},
"verificationStatus": {
"$ref": "#/components/schemas/VerificationStatus2"
}
},
"type": "object"
},
"GeoliteCountry": {
"properties": {
"code": {
"type": "string"
},
"hasEuCountryVatRegions": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"isEuCountry": {
"type": "boolean"
},
"iso2Code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"MessengerType2": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"NotificationType": {
"properties": {
"id": {
"type": "integer"
},
"handle": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"TrackerType": {
"properties": {
"handle": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "integer"
},
"logoUrl": {
"type": "string"
},
"completedGuideUrl": {
"type": "string"
}
},
"type": "object"
},
"ConversionType": {
"properties": {
"handle": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "integer"
}
},
"type": "object"
},
"UserConversionTracker": {
"properties": {
"conversionType": {
"$ref": "#/components/schemas/ConversionType"
},
"trackerType": {
"$ref": "#/components/schemas/TrackerType"
}
},
"type": "object"
},
"EuCountryVatRegionRate": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"User": {
"properties": {
"firstCampaignDate": {
"type": "string"
},
"firstPaymentDate": {
"type": "string"
},
"showDisplayAndNative": {
"type": "boolean"
},
"isNew": {
"type": "boolean"
},
"totalPaymentsCount": {
"type": "integer"
},
"balance": {
"type": "number",
"format": "float"
},
"lastBillingDate": {
"type": "string"
},
"totalCampaignsCount": {
"type": "integer"
},
"daysSinceFirstCampaign": {
"type": "integer"
},
"isTelegramChannelAvailable": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/user_status"
},
"userType": {
"type": "string"
},
"hasConversion": {
"type": "boolean"
},
"userAuthMethod": {
"type": "string"
},
"canChangePassword": {
"type": "boolean"
},
"showCapitalist": {
"type": "boolean"
},
"shouldShowOnDemandWebinarBar": {
"type": "boolean"
},
"shouldShowVatNumberNotification": {
"type": "boolean"
},
"hasMessenger": {
"type": "boolean"
},
"vatRate": {
"type": "number",
"format": "float"
},
"isNewRegistrationPageUsed": {
"type": "boolean"
},
"dsql": {
"type": "string"
},
"userVerification": {
"$ref": "#/components/schemas/UserVerification2"
},
"verificationRequired": {
"type": "boolean"
},
"retargetingListsAvailable": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"active": {
"type": "integer"
},
"visitedAddFundsPage": {
"type": "boolean"
},
"country": {
"$ref": "#/components/schemas/GeoliteCountry"
},
"messengerType": {
"$ref": "#/components/schemas/MessengerType2"
},
"messengerUser": {
"type": "string"
},
"accountType": {
"type": "string"
},
"apiKey": {
"type": "string",
"default": null,
"nullable": true
},
"mql": {
"type": "string"
},
"mql2": {
"type": "string"
},
"minDeposit": {
"type": "integer"
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationType"
}
},
"phone": {
"type": "string"
},
"richpoints": {
"type": "integer"
},
"balanceToIncreaseRichPoints": {
"type": "number",
"format": "float"
},
"hasExperienceWithTracker": {
"$ref": "#/components/schemas/TrackerType"
},
"userTrackers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserConversionTracker"
}
},
"predictLtvSum": {
"type": "number",
"format": "float"
},
"vatNumber": {
"type": "string"
},
"vatNumberValid": {
"type": "boolean"
},
"euCountryVatRegionRate": {
"$ref": "#/components/schemas/EuCountryVatRegionRate"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"companyName": {
"type": "string"
},
"userChannelTypeExperience": {
"$ref": "#/components/schemas/UserChannelTypeExperience2"
}
},
"type": "object"
},
"JwtToken": {
"properties": {
"user": {
"$ref": "#/components/schemas/User"
},
"accessToken": {
"type": "string"
},
"issuedAt": {
"type": "string",
"format": "date-time"
},
"expireAt": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"UserRequest2": {
"required": [
"recaptchaToken",
"googleIdToken"
],
"properties": {
"recaptchaToken": {
"type": "string"
},
"sourceBusterRef": {
"type": "string"
},
"invitedByUserId": {
"type": "integer"
},
"sourceBusterFull": {
"type": "object",
"additionalProperties": true
},
"googleIdToken": {
"type": "string"
},
"userUiQueryParams": {
"type": "string"
}
},
"type": "object"
},
"EmailPasswordAuthorizationRequest": {
"required": [
"email",
"password",
"recaptchaToken"
],
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string",
"maxLength": 64
},
"recaptchaToken": {
"type": "string"
},
"rememberUser": {
"type": "boolean"
},
"userUiQueryParams": {
"type": "string"
},
"recaptchaType": {
"type": "string"
},
"linkAccount": {
"type": "boolean",
"default": false
},
"linkApiKey": {
"type": "string"
}
},
"type": "object"
},
"ApiKeyAuthorizationRequest": {
"required": [
"apiKey"
],
"properties": {
"apiKey": {
"type": "string"
}
},
"type": "object"
},
"ForgotPasswordInitRequest": {
"required": [
"email"
],
"properties": {
"email": {
"type": "string"
}
},
"type": "object"
},
"ForgotPasswordResetRequest": {
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string"
},
"password": {
"type": "string",
"maxLength": 64
}
},
"type": "object"
},
"CampaignManagerReportCreateRequest": {
"required": [
"campaignId",
"row",
"startDate",
"endDate",
"sortProperty",
"sortDirection"
],
"properties": {
"campaignId": {
"type": "integer"
},
"row": {
"type": "string"
},
"columns": {
"type": "object",
"additionalProperties": true
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"sortProperty": {
"type": "string"
},
"sortDirection": {
"type": "string"
},
"filter": {
"type": "object",
"default": [],
"additionalProperties": true
},
"filterType": {
"type": "object",
"default": [],
"additionalProperties": true
},
"bulkFilter": {
"type": "object",
"default": [],
"additionalProperties": true
}
},
"type": "object"
},
"CampaignManagerReportItemResponseDTO": {
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"UpdateReportItemsStatusRequest": {
"required": [
"isIncluded"
],
"properties": {
"isIncluded": {
"type": "boolean"
},
"excludedValues": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"BidListOperationEditRequest": {
"required": [
"parameter",
"operation",
"operationValue"
],
"properties": {
"parameter": {
"type": "string",
"enum": [
"ssp_id",
"site_id",
"publisher_id",
"os",
"device",
"creative_id"
]
},
"operation": {
"type": "string",
"enum": [
"+",
"-",
"*",
"/",
"="
]
},
"operationValue": {
"type": "number",
"format": "float",
"maximum": 100,
"minimum": 0
}
},
"type": "object"
},
"UpdateReportItemBidListItemsRequest": {
"required": [
"operation"
],
"properties": {
"excludedValues": {
"type": "object",
"additionalProperties": true
},
"operation": {
"oneOf": [
{
"$ref": "#/components/schemas/BidListOperationEditRequest"
}
]
}
},
"type": "object"
},
"DeleteReportItemBidListItemsRequest": {
"properties": {
"excludedValues": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"SspRequest": {
"type": "object"
},
"SiteRequest": {
"type": "object"
},
"DevicesRequest": {
"required": [
"values",
"isIncluded"
],
"properties": {
"values": {
"type": "object",
"additionalProperties": true
},
"isIncluded": {
"type": "boolean"
}
},
"type": "object"
},
"OsRequest": {
"required": [
"values",
"isIncluded"
],
"properties": {
"values": {
"type": "object",
"additionalProperties": true
},
"isIncluded": {
"type": "boolean"
}
},
"type": "object"
},
"DevicesRequest2": {
"type": "object"
},
"BidListItemsEditRequest": {
"required": [
"operation",
"values"
],
"properties": {
"operation": {
"oneOf": [
{
"$ref": "#/components/schemas/BidListOperationEditRequest"
}
]
},
"values": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"BidListItemsDeleteRequest": {
"required": [
"parameter",
"values"
],
"properties": {
"parameter": {
"type": "string",
"enum": [
"ssp_id",
"site_id",
"publisher_id",
"os",
"device",
"creative_id"
]
},
"values": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"Bonus": {
"properties": {
"type": {
"type": "string"
},
"bonusLogoUrl": {
"type": "string"
},
"discount": {
"type": "string"
},
"id": {
"type": "integer"
},
"companyName": {
"type": "string"
},
"companyLink": {
"type": "string"
},
"promoCode": {
"type": "string"
},
"description": {
"type": "string"
},
"about": {
"type": "string"
},
"active": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updateAt": {
"type": "string",
"format": "date-time"
},
"sort": {
"type": "integer"
}
},
"type": "object"
},
"ConversionTypeTrackerUrl": {
"properties": {
"id": {
"type": "integer"
},
"conversionType": {
"$ref": "#/components/schemas/ConversionType"
},
"trackerType": {
"$ref": "#/components/schemas/TrackerType"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"ConversionType2": {
"type": "object"
},
"TrackerType2": {
"type": "object"
},
"UserConversionTrackerRequest": {
"properties": {
"conversionType": {
"$ref": "#/components/schemas/ConversionType2"
},
"trackerType": {
"$ref": "#/components/schemas/TrackerType2"
}
},
"type": "object"
},
"UserTrackerTestConversionRequest": {
"required": [
"destinationUrl"
],
"properties": {
"conversionType": {
"$ref": "#/components/schemas/ConversionType2"
},
"trackerType": {
"$ref": "#/components/schemas/TrackerType2"
},
"destinationUrl": {
"type": "string",
"maxLength": 2000
}
},
"type": "object"
},
"ReuseCreativeMessageOrTitleDTO": {
"properties": {},
"type": "object"
},
"CreativeIconsDTO": {
"properties": {},
"type": "object"
},
"PushCreativeRequestDTO": {
"required": [
"title",
"icon"
],
"properties": {
"destinationUrl": {
"description": "Destination URL the user is redirected to on click",
"type": "string",
"maxLength": 512,
"example": "https://example.com/offer",
"nullable": true
},
"title": {
"description": "Push notification title (max 30 characters)",
"type": "string",
"maxLength": 30,
"example": "Special Offer!"
},
"icon": {
"description": "Icon image URL for the push notification",
"type": "string",
"example": "https://cdn.example.com/icon.png"
},
"message": {
"description": "Push notification body text (max 45 characters)",
"type": "string",
"maxLength": 45,
"example": "Click to learn more",
"nullable": true
},
"image": {
"description": "Banner image URL for the push notification",
"type": "string",
"example": "https://cdn.example.com/banner.jpg",
"nullable": true
}
},
"type": "object"
},
"PushCreativeResponseDTO": {
"properties": {
"id": {
"description": "Creative ID",
"type": "integer",
"example": 1
},
"title": {
"description": "Push notification title",
"type": "string",
"example": "Special Offer!"
},
"status": {
"description": "Creative status",
"type": "string",
"example": "active"
},
"icon": {
"description": "Icon image URL",
"type": "string",
"example": "https://cdn.example.com/icon.png"
},
"image": {
"description": "Banner image URL",
"type": "string",
"example": "https://cdn.example.com/banner.jpg"
},
"message": {
"description": "Push notification body text",
"type": "string",
"example": "Click to learn more"
},
"destinationUrl": {
"description": "Destination URL",
"type": "string",
"example": "https://example.com/offer"
}
},
"type": "object"
},
"EuCountryVatRegionRate2": {
"type": "object"
},
"UpdateProfileRequest": {
"required": [
"name",
"accountType",
"email"
],
"properties": {
"name": {
"type": "string",
"maxLength": 50
},
"city": {
"type": "string"
},
"address": {
"type": "string"
},
"phone": {
"type": "string"
},
"accountType": {
"type": "string",
"enum": [
"individual",
"company"
]
},
"companyName": {
"type": "string"
},
"vatNumber": {
"type": "string"
},
"euCountryVatRegionRate": {
"$ref": "#/components/schemas/EuCountryVatRegionRate2"
},
"email": {
"type": "string"
},
"notifications": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"UserPasswordRequest": {
"required": [
"password",
"confirmPassword"
],
"properties": {
"password": {
"type": "string",
"maxLength": 64
},
"confirmPassword": {
"type": "string"
}
},
"type": "object"
},
"UserPasswordRequest2": {
"type": "object"
},
"CreateRetargetingListRequest": {
"properties": {
"name": {
"type": "string",
"default": "",
"maxLength": 255
}
},
"type": "object"
},
"ProductTourRequest": {
"required": [
"productTourTypeHandle"
],
"properties": {
"productTourTypeHandle": {
"type": "string"
}
},
"type": "object"
},
"GeoliteCountry2": {
"type": "object"
},
"ActivationRequest": {
"required": [
"name",
"country",
"timezone",
"accountType"
],
"properties": {
"name": {
"type": "string",
"maxLength": 50
},
"country": {
"oneOf": [
{
"$ref": "#/components/schemas/GeoliteCountry2"
}
]
},
"messengerType": {
"$ref": "#/components/schemas/MessengerType"
},
"messengerUser": {
"type": "string",
"maxLength": 50
},
"timezone": {
"type": "integer"
},
"userChannelTypeExperience": {
"$ref": "#/components/schemas/UserChannelTypeExperience2"
},
"whereFindOther": {
"type": "string",
"default": ""
},
"accountType": {
"type": "string",
"enum": [
"individual",
"company"
]
},
"vatNumber": {
"type": "string"
},
"euCountryVatRegionRate": {
"$ref": "#/components/schemas/EuCountryVatRegionRate2"
}
},
"type": "object"
},
"UserVatNumberRequest": {
"required": [
"vatNumber"
],
"properties": {
"vatNumber": {
"type": "string"
}
},
"type": "object"
},
"DeviceType": {
"properties": {
"id": {
"type": "integer"
},
"handle": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"PrePayInvoiceRequest": {
"properties": {
"sum": {
"type": "number"
},
"companyDetails": {
"type": "string"
}
},
"type": "object"
},
"UnsubscribeNotificationsRequest": {
"required": [
"token"
],
"properties": {
"token": {
"type": "string"
},
"notifications": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"User2": {
"properties": {
"balance": {
"type": "number",
"format": "float"
},
"retargetingListsAvailable": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"BalanceResponse": {
"properties": {
"balance": {
"description": "Current account balance",
"type": "number",
"format": "float",
"example": 1234.56
},
"currency": {
"description": "Balance currency",
"type": "string",
"default": "USD",
"example": "USD"
}
},
"type": "object"
},
"TransactionItem": {
"properties": {
"id": {
"description": "Transaction id",
"type": "string",
"example": "123"
},
"type": {
"description": "Transaction type",
"type": "string",
"enum": [
"deposit",
"spend"
],
"example": "deposit"
},
"amount": {
"description": "Transaction amount",
"type": "number",
"format": "float",
"example": 500
},
"currency": {
"description": "Transaction currency",
"type": "string",
"example": "USD"
},
"createdAt": {
"description": "Transaction creation time (ISO 8601)",
"type": "string",
"format": "date-time",
"example": "2024-01-15T12:00:00+00:00"
},
"description": {
"description": "Transaction description",
"type": "string",
"example": "Top up"
}
},
"type": "object"
},
"PaginationMeta": {
"properties": {
"totalPages": {
"description": "Total number of pages",
"type": "integer",
"example": 3
},
"page": {
"description": "Current page number",
"type": "integer",
"example": 1
},
"perPage": {
"description": "Number of items per page",
"type": "integer",
"example": 20
},
"totalItems": {
"description": "Total number of matching items",
"type": "integer",
"example": 42
}
},
"type": "object"
},
"TransactionsResponse": {
"properties": {
"data": {
"description": "List of transactions",
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionItem"
}
},
"pagination": {
"description": "Pagination metadata",
"oneOf": [
{
"$ref": "#/components/schemas/PaginationMeta"
}
]
}
},
"type": "object"
},
"Throwable": {
"type": "object"
},
"ApiException": {
"properties": {
"string": {
"type": "string",
"default": ""
},
"file": {
"type": "string",
"default": ""
},
"line": {
"type": "integer",
"default": 0
},
"previous": {
"default": null,
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Throwable"
}
]
}
},
"type": "object"
},
"Browser": {
"type": "object"
},
"TimetableDTO": {
"required": [
"day",
"hours"
],
"properties": {
"day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"hours": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"ScheduleRequestDTO": {
"required": [
"timezone"
],
"properties": {
"timezone": {
"description": "Timezone mode for date/time fields",
"type": "string",
"enum": [
"utc",
"local"
],
"example": "utc"
},
"dateFrom": {
"description": "Campaign start date (YYYY-MM-DD)",
"type": "string",
"format": "date",
"example": "2024-06-01",
"nullable": true
},
"dateTo": {
"description": "Campaign end date (YYYY-MM-DD)",
"type": "string",
"format": "date",
"example": "2024-12-31",
"nullable": true
},
"timeFrom": {
"description": "Daily start time (HH:MM)",
"type": "string",
"example": "08:00",
"nullable": true
},
"timeTo": {
"description": "Daily end time (HH:MM)",
"type": "string",
"example": "22:00",
"nullable": true
},
"timetable": {
"description": "Weekly timetable for dayparting \u2014 array of day/hours entries",
"type": "array",
"items": {
"$ref": "#/components/schemas/TimetableDTO"
},
"default": []
}
},
"type": "object"
},
"SchedulerResponseDTO": {
"properties": {
"timezone": {
"description": "Timezone mode",
"type": "string",
"enum": [
"utc",
"local"
],
"example": "utc"
},
"dateFrom": {
"description": "Campaign start date",
"type": "string",
"example": "2024-06-01",
"nullable": true
},
"dateTo": {
"description": "Campaign end date",
"type": "string",
"example": "2024-12-31",
"nullable": true
},
"timeFrom": {
"description": "Daily start time",
"type": "string",
"example": "08:00",
"nullable": true
},
"timeTo": {
"description": "Daily end time",
"type": "string",
"example": "22:00",
"nullable": true
},
"timetable": {
"description": "Weekly timetable for dayparting",
"type": "array",
"items": {
"$ref": "#/components/schemas/TimetableDTO"
},
"default": []
}
},
"type": "object"
},
"SourcesWithBlockWhiteListRequestDTO": {
"properties": {
"list": {
"description": "SSP (supply-side platform) IDs assigned to the campaign",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"example": [
1,
5,
12
]
},
"whiteList": {
"description": "Whitelisted site IDs for the campaign. Each ID is a unique 32-character string.",
"type": "array",
"items": {
"type": "string",
"maxLength": 32,
"minLength": 32
},
"default": [],
"example": [
"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3"
]
},
"blockList": {
"description": "Blocked (blacklisted) site IDs for the campaign. Each ID is a unique 32-character string. Use this field to check which sites are currently blocked.",
"type": "array",
"items": {
"type": "string",
"maxLength": 32,
"minLength": 32
},
"default": [],
"example": [
"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
"d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1"
]
}
},
"type": "object"
},
"Carrier": {
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"GeoliteCity": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ConnectionType": {
"type": "object"
},
"GeoliteCountry3": {
"properties": {
"id": {
"type": "integer"
},
"iso3code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"Sizes": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
}
},
"type": "object"
},
"EntityStatusResponseDTO": {
"properties": {
"id": {
"description": "Entity ID",
"type": "integer",
"example": 1
},
"status": {
"description": "Current status name",
"type": "string",
"example": "active"
}
},
"type": "object"
},
"PopsCreativeRequestDTO": {
"type": "object"
},
"PopsCreativeResponseDTO": {
"properties": {
"id": {
"description": "Creative ID",
"type": "integer",
"example": 3
},
"status": {
"description": "Creative status",
"type": "string",
"example": "active"
},
"destinationUrl": {
"description": "Destination URL",
"type": "string",
"example": "https://example.com/landing"
}
},
"type": "object"
},
"DisplayCreativeResponseDTO": {
"properties": {
"id": {
"description": "Creative ID",
"type": "integer",
"example": 5
},
"image": {
"description": "Display banner image URL",
"type": "string",
"example": "https://cdn.example.com/banner_300x250.jpg"
},
"status": {
"description": "Creative status",
"type": "string",
"example": "active"
},
"destinationUrl": {
"description": "Destination URL",
"type": "string",
"example": "https://example.com/offer"
},
"size": {
"description": "Creative size ID",
"type": "integer",
"example": 1
},
"landingPageUrl": {
"description": "Landing page URL",
"type": "string",
"example": "https://example.com"
}
},
"type": "object"
},
"DisplayCreativeRequestDTO": {
"properties": {
"destinationUrl": {
"description": "Destination URL the user is redirected to on click",
"type": "string",
"maxLength": 512,
"example": "https://example.com/offer",
"nullable": true
},
"image": {
"description": "Display banner image URL",
"type": "string",
"example": "https://cdn.example.com/banner_300x250.jpg",
"nullable": true
},
"size": {
"description": "Size ID for display campaign",
"type": "integer",
"example": 1
},
"landingPageUrl": {
"description": "Landing page URL for verification",
"type": "string",
"example": "https://example.com",
"nullable": true
}
},
"type": "object"
},
"Isp": {
"type": "object"
},
"GeoliteRegion": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
}
},
"type": "object"
},
"RtbNetwork": {
"properties": {
"id": {
"type": "integer"
},
"isInPage": {
"type": "boolean"
},
"isIosCalendar": {
"type": "boolean"
},
"priorityGroup": {
"type": "string"
}
},
"type": "object"
},
"RtbNetwork2": {
"properties": {
"id": {
"type": "integer"
},
"isDomainTraffic": {
"type": "boolean"
},
"priorityGroup": {
"type": "string"
}
},
"type": "object"
},
"RtbNetwork3": {
"properties": {
"id": {
"type": "integer"
},
"priorityGroup": {
"type": "string"
}
},
"type": "object"
},
"TargetingRegionDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"regionIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"TargetingCityDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"cityIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"TargetingImpressionPerUserDTO": {
"required": [
"impressions",
"period"
],
"properties": {
"impressions": {
"type": "integer",
"maximum": 3,
"minimum": 1
},
"period": {
"type": "integer",
"enum": [
1,
7,
30,
60,
90
]
},
"sourceDefinition": {
"type": "integer"
}
},
"type": "object"
},
"TargetingClickPerUserDTO": {
"required": [
"clicks",
"period"
],
"properties": {
"clicks": {
"type": "integer",
"maximum": 3,
"minimum": 1
},
"period": {
"type": "integer",
"enum": [
1,
7,
30,
60,
90
]
}
},
"type": "object"
},
"TargetingRequestDTO": {
"required": [
"country",
"deviceTypes",
"regions",
"cities",
"impressionsPerUser",
"clicksPerUser"
],
"properties": {
"country": {
"description": "ISO 3166-1 alpha-3 country code",
"type": "string",
"maxLength": 3,
"example": "USA"
},
"deviceTypes": {
"description": "Targeted device types (case-sensitive)",
"type": "array",
"items": {
"type": "string",
"enum": [
"Mobile",
"Tablet",
"Desktop"
]
},
"example": [
"Mobile",
"Tablet",
"Desktop"
]
},
"regions": {
"description": "Region targeting settings",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingRegionDTO"
}
]
},
"cities": {
"description": "City targeting settings",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingCityDTO"
}
]
},
"impressionsPerUser": {
"description": "Impression frequency capping per user",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingImpressionPerUserDTO"
}
]
},
"clicksPerUser": {
"description": "Click frequency capping per user",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingClickPerUserDTO"
}
]
}
},
"type": "object"
},
"UpdateAdvancedTargetingRequestDTO": {
"required": [
"mainstreamOnly",
"newSubscribersOnly"
],
"properties": {
"mainstreamOnly": {
"description": "Only show ads on mainstream (non-adult) traffic",
"type": "boolean",
"example": true
},
"webviewAllowed": {
"description": "Allow traffic from in-app webviews",
"type": "boolean",
"default": true,
"example": true
},
"newSubscribersOnly": {
"description": "Target only new subscribers (recently subscribed users)",
"type": "boolean",
"example": false
}
},
"type": "object"
},
"UpdateAdvancedTargetingCarrierItemRequestDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"UpdateAdvancedTargetingOsItemRequestDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"UpdateAdvancedTargetingConnectionTypeItemRequestDTO": {
"required": [
"relationType",
"list"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"UpdateAdvancedTargetingConnectionTypeResponseDTO": {
"properties": {
"relationType": {
"type": "string"
},
"list": {
"type": "object",
"additionalProperties": true
}
},
"type": "object"
},
"AdvancedTargetingBrowserListItemRequestDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"type": "object"
},
"AdvancedTargetingBrowserListResponseDTO": {
"properties": {
"list": {
"type": "array",
"items": {
"type": "string"
}
},
"relationType": {
"type": "string"
}
},
"type": "object"
},
"AdvancedTargetingBrowserLanguageListItemRequestDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"type": "object"
},
"AdvancedTargetingBrowserLanguageListResponseDTO": {
"properties": {
"list": {
"type": "array",
"items": {
"type": "string"
}
},
"relationType": {
"type": "string"
}
},
"type": "object"
},
"AdvancedTargetingIspListItemRequestDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"type": "object"
},
"AdvancedTargetingIspListResponseDTO": {
"properties": {
"list": {
"type": "array",
"items": {
"type": "string"
}
},
"relationType": {
"type": "string"
}
},
"type": "object"
},
"AdvancedTargetingIpListItemRequestDTO": {
"required": [
"relationType"
],
"properties": {
"relationType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"list": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"type": "object"
},
"AdvancedTargetingIpListResponseDTO": {
"properties": {
"list": {
"type": "array",
"items": {
"type": "string"
}
},
"relationType": {
"type": "string"
}
},
"type": "object"
},
"UniversalCreativeResponseDTO": {
"required": [
"title",
"icon"
],
"properties": {
"destinationUrl": {
"type": "string",
"maxLength": 512
},
"title": {
"type": "string",
"maxLength": 30
},
"icon": {
"type": "string"
},
"message": {
"type": "string",
"maxLength": 45
},
"image": {
"type": "string"
},
"size": {
"type": "integer"
},
"landingPageUrl": {
"type": "string"
},
"banner": {
"type": "string"
},
"brand": {
"type": "string"
},
"button": {
"type": "string"
},
"video": {
"type": "string"
},
"playable": {
"type": "string"
}
},
"type": "object"
},
"TargetingRequestDTO2": {
"required": [
"country",
"deviceTypes",
"regions",
"cities",
"impressionsPerUser",
"clicksPerUser"
],
"properties": {
"country": {
"description": "ISO 3166-1 alpha-3 country code",
"type": "string",
"maxLength": 3,
"example": "USA"
},
"deviceTypes": {
"description": "Targeted device types (case-sensitive)",
"type": "array",
"items": {
"type": "string",
"enum": [
"Mobile",
"Tablet",
"Desktop"
]
},
"example": [
"Mobile",
"Tablet",
"Desktop"
]
},
"regions": {
"description": "Region targeting settings",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingRegionDTO"
}
]
},
"cities": {
"description": "City targeting settings",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingCityDTO"
}
]
},
"impressionsPerUser": {
"description": "Impression frequency capping per user",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingImpressionPerUserDTO"
}
]
},
"clicksPerUser": {
"description": "Click frequency capping per user",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingClickPerUserDTO"
}
]
},
"onlyPremiumSubscription": {
"type": "boolean",
"default": false
},
"walletTargeting": {
"type": "boolean",
"default": false
},
"excludeVpnProxyUsers": {
"type": "boolean",
"default": false
},
"motivated": {
"type": "string"
}
},
"type": "object"
},
"CampaignBudgetDTO": {
"required": [
"budgetAmount",
"pacingType",
"budgetPeriod",
"maxBid"
],
"properties": {
"budgetAmount": {
"description": "Daily or total budget amount",
"type": "number",
"format": "float",
"maximum": 1000000,
"minimum": 0,
"example": 100
},
"pacingType": {
"description": "Budget pacing type",
"type": "string",
"enum": [
"asap",
"even"
],
"example": "even"
},
"budgetPeriod": {
"description": "Budget period type",
"type": "string",
"enum": [
"unlimited",
"perDay"
],
"example": "perDay"
},
"cpaGoal": {
"description": "Target CPA goal",
"type": "number",
"format": "float",
"maximum": 1000000,
"example": 2.5,
"nullable": true
},
"maxBid": {
"description": "Maximum bid amount",
"type": "number",
"format": "float",
"example": 0.15
}
},
"type": "object"
},
"AdvancedTargetingRequestDTO": {
"properties": {
"mainstreamOnly": {
"type": "boolean",
"default": false
},
"webviewAllowed": {
"type": "boolean",
"default": false
},
"newSubscribersOnly": {
"type": "boolean",
"default": false
},
"impressionNumber": {
"type": "integer",
"maximum": 25,
"minimum": 1
},
"carrier": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingCarrierItemRequestDTO"
},
"connectionType": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingConnectionTypeItemRequestDTO"
},
"browser": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserListItemRequestDTO"
},
"browserLanguage": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserLanguageListItemRequestDTO"
},
"language": {
"$ref": "#/components/schemas/AdvancedTargetingBrowserLanguageListItemRequestDTO"
},
"isp": {
"$ref": "#/components/schemas/AdvancedTargetingIspListItemRequestDTO"
},
"ip": {
"$ref": "#/components/schemas/AdvancedTargetingIpListItemRequestDTO"
},
"os": {
"$ref": "#/components/schemas/UpdateAdvancedTargetingOsItemRequestDTO"
}
},
"type": "object"
},
"ScheduleResponseDTO": {
"required": [
"timezone"
],
"properties": {
"timezone": {
"type": "string",
"enum": [
"utc",
"local"
]
},
"dateFrom": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"timeFrom": {
"type": "string"
},
"timeTo": {
"type": "string"
},
"timetable": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimetableDTO"
},
"default": []
}
},
"type": "object"
},
"CampaignCreatorResponse": {
"properties": {
"id": {
"description": "Campaign ID",
"type": "integer",
"example": 12345
},
"status": {
"description": "Campaign status",
"type": "string",
"example": "active"
},
"type": {
"description": "Campaign channel type",
"type": "string",
"enum": [
"push",
"pops",
"display"
],
"example": "push"
},
"telegramType": {
"description": "Telegram campaign subtype (null for non-Telegram campaigns)",
"type": "string",
"example": null,
"nullable": true
},
"name": {
"description": "Campaign name",
"type": "string",
"example": "My Push Campaign"
},
"creatives": {
"description": "List of creatives attached to the campaign",
"type": "array",
"items": {
"$ref": "#/components/schemas/UniversalCreativeResponseDTO"
}
},
"targeting": {
"description": "Targeting settings (country, device types, regions, etc.)",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingRequestDTO2"
}
]
},
"budget": {
"description": "Budget and bidding settings",
"oneOf": [
{
"$ref": "#/components/schemas/CampaignBudgetDTO"
}
]
},
"advancedTargeting": {
"description": "Advanced targeting settings (mainstream, webview, subscribers)",
"oneOf": [
{
"$ref": "#/components/schemas/AdvancedTargetingRequestDTO"
}
]
},
"schedule": {
"description": "Campaign schedule (dates, times, timetable)",
"oneOf": [
{
"$ref": "#/components/schemas/ScheduleResponseDTO"
}
]
},
"sources": {
"description": "SSP sources, whitelist, and blocklist",
"oneOf": [
{
"$ref": "#/components/schemas/SourcesWithBlockWhiteListRequestDTO"
}
]
}
},
"type": "object"
},
"CampaignListResponse": {
"properties": {
"data": {
"description": "List of campaigns",
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignCreatorResponse"
}
},
"pagination": {
"description": "Pagination metadata",
"oneOf": [
{
"$ref": "#/components/schemas/PaginationMeta"
}
]
}
},
"type": "object"
},
"UniversalCreativeRequestDTO": {
"required": [
"title",
"icon"
],
"properties": {
"destinationUrl": {
"type": "string",
"maxLength": 512
},
"title": {
"type": "string",
"maxLength": 30
},
"icon": {
"type": "string"
},
"message": {
"type": "string",
"maxLength": 45
},
"image": {
"type": "string"
},
"size": {
"description": "Size Id for display campaign",
"type": "int",
"example": 1
},
"landingPageUrl": {
"type": "string"
}
},
"type": "object"
},
"CreateCampaignRequestDTO": {
"required": [
"type",
"creatives",
"targeting",
"budget",
"sources"
],
"properties": {
"type": {
"description": "Campaign channel type",
"type": "string",
"enum": [
"push",
"pops",
"display"
],
"example": "push"
},
"name": {
"description": "Campaign name (auto-generated if omitted)",
"type": "string",
"example": "My Push Campaign",
"nullable": true
},
"creatives": {
"description": "Array of creatives to attach to the campaign",
"type": "array",
"items": {
"$ref": "#/components/schemas/UniversalCreativeRequestDTO"
}
},
"targeting": {
"description": "Targeting settings (country, device types, regions, etc.)",
"oneOf": [
{
"$ref": "#/components/schemas/TargetingRequestDTO2"
}
]
},
"budget": {
"description": "Budget and bidding configuration",
"oneOf": [
{
"$ref": "#/components/schemas/CampaignBudgetDTO"
}
]
},
"advancedTargeting": {
"description": "Optional advanced targeting settings",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AdvancedTargetingRequestDTO"
}
]
},
"schedule": {
"description": "Optional campaign schedule",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ScheduleRequestDTO"
}
]
},
"sources": {
"description": "SSP sources, whitelist, and blocklist",
"oneOf": [
{
"$ref": "#/components/schemas/SourcesWithBlockWhiteListRequestDTO"
}
]
}
},
"type": "object"
},
"UpdateCampaignBidRequestDTO": {
"required": [
"bid"
],
"properties": {
"bid": {
"description": "Campaign bid in USD (CPM for pops, CPC for push/display)",
"type": "number",
"format": "float",
"minimum": 0,
"exclusiveMinimum": true,
"example": 0.025
}
},
"type": "object"
},
"UpdateCampaignBidResponseDTO": {
"properties": {
"id": {
"description": "Campaign ID",
"type": "integer",
"example": 12345
},
"bid": {
"description": "Updated bid in API format (USD)",
"type": "number",
"format": "float",
"example": 0.025
},
"updatedAt": {
"description": "Update timestamp (ISO-8601)",
"type": "string",
"format": "date-time",
"example": "2026-07-24T12:00:00+00:00"
}
},
"type": "object"
},
"CampaignStatsItem": {
"properties": {
"date": {
"description": "Date or grouping key",
"type": "string",
"example": "2024-01-01"
},
"impressions": {
"description": "Total impressions",
"type": "integer",
"example": 15000
},
"clicks": {
"description": "Total clicks",
"type": "integer",
"example": 350
},
"conversions": {
"description": "Total conversions",
"type": "integer",
"example": 25
},
"conversions1": {
"description": "Approved conversions",
"type": "integer",
"example": 20
},
"conversions2": {
"description": "Conversions 2",
"type": "integer",
"example": 15
},
"conversions3": {
"description": "Conversions 3",
"type": "integer",
"example": 10
},
"spend": {
"description": "Total spend in USD",
"type": "number",
"format": "float",
"example": 175.5
},
"ctr": {
"description": "Click-through rate percentage",
"type": "number",
"format": "float",
"example": 2.33
},
"conversionRate": {
"description": "Conversion rate percentage",
"type": "number",
"format": "float",
"example": 7.14
},
"cpc": {
"description": "Cost per click in USD",
"type": "number",
"format": "float",
"example": 0.5
},
"cpa": {
"description": "Cost per acquisition in USD",
"type": "number",
"format": "float",
"example": 7.02
}
},
"type": "object"
},
"AdvertiserStatsResponse": {
"properties": {
"data": {
"description": "Statistics rows",
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignStatsItem"
}
},
"pagination": {
"description": "Pagination metadata",
"oneOf": [
{
"$ref": "#/components/schemas/PaginationMeta"
}
]
}
},
"type": "object"
},
"UploadPartnerCsvResponseDTO": {
"properties": {
"uploadId": {
"type": "integer",
"example": 123
},
"segmentId": {
"type": "integer",
"example": 456
},
"filename": {
"type": "string",
"example": "42_2026-07-31_143045_65f3a1b2c3d4e5f6.csv"
},
"fileSizeBytes": {
"type": "integer",
"example": 1048576
},
"createdAt": {
"type": "string",
"example": "2026-07-31T09:27:00+00:00"
}
},
"type": "object"
},
"BillingFilterRequest": {
"required": [
"page",
"limit"
],
"properties": {
"period": {
"type": "string",
"enum": [
"yesterday",
"year",
"today",
"last_7_days",
"last_30_days",
"previous_month",
"current_month",
"custom"
]
},
"dateFrom": {
"type": "string",
"format": "date-time"
},
"dateTo": {
"type": "string",
"format": "date-time"
},
"query": {
"type": "string"
},
"userType": {
"type": "integer",
"enum": [
1,
2,
4
]
},
"type": {
"type": "string",
"enum": [
"any",
"debit",
"credit"
]
},
"order": {
"type": "string",
"enum": [
"id",
"created",
"comment",
"debit",
"credit",
"balance",
"username",
"userType",
"subdomain"
]
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"type": "object"
}
},
"securitySchemes": {
"ApiKeyBearer": {
"type": "http",
"description": "Pass your API key as a Bearer token: Authorization: Bearer ",
"scheme": "bearer"
}
}
},
"security": [
{
"ApiKeyBearer": []
}
],
"tags": [
{
"name": "webinars"
},
{
"name": "predict"
},
{
"name": "report"
},
{
"name": "campaign-info"
},
{
"name": "campaigns_list"
},
{
"name": "user_channel_experience_type"
},
{
"name": "create_user_verification"
},
{
"name": "auth"
},
{
"name": "campaign_manager_report"
},
{
"name": "country"
},
{
"name": "conversion-type-tracker-urls"
},
{
"name": "create-user-conversion-tracker"
},
{
"name": "create-user-tracker-test-conversion"
},
{
"name": "user-completed-tracker-test-conversion"
},
{
"name": "creatives-messages"
},
{
"name": "creatives-titles"
},
{
"name": "creatives-icons"
},
{
"name": "telegram-creatives-icons"
},
{
"name": "api_push_creatives"
},
{
"name": "api_push_creatives_update"
},
{
"name": "api_push_creatives_delete"
},
{
"name": "current_user_info"
},
{
"name": "update_current_user"
},
{
"name": "update_current_user_password"
},
{
"name": "update_current_user_settings"
},
{
"name": "current_user"
},
{
"name": "Retargeting lists"
},
{
"name": "automatically_activate_user"
},
{
"name": "update_and_validate_current_user_vat_number"
},
{
"name": "unification"
},
{
"name": "device_types"
},
{
"name": "invoice"
},
{
"name": "messenger_type"
},
{
"name": "notification"
},
{
"name": "notifications_unsubscribe"
},
{
"name": "User"
},
{
"name": "Finance"
},
{
"name": "Reference Data"
},
{
"name": "Campaigns"
},
{
"name": "Creatives"
},
{
"name": "SSP Sources"
},
{
"name": "Targeting"
},
{
"name": "api_v3_sites"
},
{
"name": "api_v3_stats"
},
{
"name": "api_v3_direct_link_stats"
},
{
"name": "api_v3_zone_code"
},
{
"name": "api_v4_segments"
},
{
"name": "billing"
},
{
"name": "insight"
}
]
}