{"openapi":"3.0.0","info":{"title":"SendPulse Pop-up API","version":"1.0"},"servers":[{"url":"https:\/\/login.sendpulse.com\/api\/pop-ups\/","description":"Production server"}],"paths":{"\/public\/api\/widgets\/list":{"get":{"tags":["Project"],"summary":"Get a list of projects","description":"Returns a list of projects with information about each project","parameters":[{"name":"first","in":"query","description":"Limit on the number of displayed records. The default number is 10.","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Limit on the number of displayed records","schema":{"type":"integer"}}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"List projects","type":"array","items":{"$ref":"#\/components\/schemas\/project"}},"pageInfo":{"$ref":"#\/components\/schemas\/pageInfo"}},"type":"object"}}}},"400":{"description":"Validation error"},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/widgets":{"post":{"tags":["Project"],"summary":"Create a project","description":"Creates a new project with the specified properties and returns a copy of the information with the project ID","requestBody":{"content":{"application\/json":{"schema":{"properties":{"name":{"type":"string","description":"Project name"},"url":{"type":"string","description":"Project website URL"}},"type":"object"}}}},"responses":{"201":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"$ref":"#\/components\/schemas\/project"}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"name.length.max":"Too long, max length - {{255}}","url":"Invalid URL 'bad_url'"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/popups\/conditions":{"get":{"tags":["Popup"],"summary":"Get a list of available display conditions for popups","description":"Returns a list of available display conditions for popups with detailed information","responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"List of available display conditions","type":"array","items":{"$ref":"#\/components\/schemas\/scenarioSetting"}},"pageInfo":{"$ref":"#\/components\/schemas\/pageInfo"}},"type":"object"}}}}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/popups\/list\/quiz\/{projectId}":{"get":{"tags":["Popup"],"summary":"Get a list of quiz pop-ups by your project ID","description":"Returns a list of quiz pop-ups using your project ID with information about each pop-up","parameters":[{"name":"projectId","in":"path","description":"Project ID","schema":{"type":"string","format":"uuid"},"required":true},{"name":"first","in":"query","description":"Limit on the number of displayed records. The default number is 10","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Limit on the number of displayed records","schema":{"type":"integer"}}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"List of popups","type":"array","items":{"$ref":"#\/components\/schemas\/popup"}},"pageInfo":{"$ref":"#\/components\/schemas\/pageInfo"}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"widgetId":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f20'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"403":{"$ref":"#\/components\/schemas\/accessDeniedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/popups\/list\/{projectId}":{"get":{"tags":["Popup"],"summary":"Get a list of pop-ups by your project ID","description":"Returns a list of pop-ups using your project ID with information about each pop-up","parameters":[{"name":"projectId","in":"path","description":"Project ID","schema":{"type":"string","format":"uuid"},"required":true},{"name":"first","in":"query","description":"Limit on the number of displayed records. The default number is 10","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Limit on the number of displayed records","schema":{"type":"integer"}}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"List of popups","type":"array","items":{"$ref":"#\/components\/schemas\/popup"}},"pageInfo":{"$ref":"#\/components\/schemas\/pageInfo"}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"widgetId":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f20'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"403":{"$ref":"#\/components\/schemas\/accessDeniedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/popups\/{popupId}\/set-state":{"post":{"tags":["Popup"],"summary":"Set a pop-up state","description":"Enables or disables a pop-up on your website","parameters":[{"name":"popupId","in":"path","description":"Pop-up ID. It can be obtained using the \"Get a list of projects\" method or in the pop-up builder address bar in your account.","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"is_enabled":{"type":"boolean","description":"Sets a pop-up state. If you want to enable your pop-up, pass \"true\", and if you want to disable it, pass \"false\"."}},"type":"object"}}}},"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"$ref":"#\/components\/schemas\/popup"}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"id":"Invalid id {{'af1b0e2a-bff9-4d09-a7d9-99d61d2b43b'}}","isEnabled":"Invalid boolean value '23'"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/popups\/{popupId}":{"delete":{"tags":["Popup"],"summary":"Delete popup","description":"Delete popup","parameters":[{"name":"popupId","in":"path","description":"Pop-up ID. It can be obtained using the \"Get a list of projects\" method or in the pop-up builder address bar in your account.","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"is_enabled":{"type":"boolean","description":"Delete popup\"."}},"type":"object"}}}},"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"id":"Invalid id {{'af1b0e2a-bff9-4d09-a7d9-99d61d2b43b'}}","isEnabled":"Invalid boolean value '23'"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"403":{"$ref":"#\/components\/schemas\/accessDeniedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/statistics\/widget\/{projectId}":{"get":{"tags":["Project statistic"],"summary":"Get statistics about your project","description":"Returns the information about how many site visitors saw your all your pop-ups in a project and interacted with them","parameters":[{"name":"projectId","in":"path","description":"Project ID","schema":{"type":"string","format":"uuid"},"required":true},{"name":"start","in":"query","description":"Start date timestamp","schema":{"type":"integer"},"required":false},{"name":"end","in":"query","description":"End date timestamp","schema":{"type":"integer"},"required":false}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"Project statistic","type":"array","items":{"$ref":"#\/components\/schemas\/projectStatistic"}}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"id":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f203'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/statistics\/popup\/{popupId}":{"get":{"tags":["Popup statistic"],"summary":"Get statistics about your pop-up","description":"Returns the information about how many site visitors saw your your pop-up and interacted with them","parameters":[{"name":"popupId","in":"path","description":"Pop-up ID","schema":{"type":"string","format":"uuid"},"required":true},{"name":"start","in":"query","description":"Start date timestamp","schema":{"type":"integer"},"required":false},{"name":"end","in":"query","description":"End date timestamp","schema":{"type":"integer"},"required":false}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"Popup statistic","type":"array","items":{"$ref":"#\/components\/schemas\/popupStatistic"}}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"id":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f203'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/statistics\/nps\/{popupId}":{"get":{"tags":["Popup statistic"],"summary":"Get NPS variants statistics and base NPS button\/buttons info","description":"Returns list of NPS variants with total amount of voices for each","parameters":[{"name":"popupId","in":"path","description":"Pop-up ID","schema":{"type":"string","format":"uuid"},"required":true},{"name":"start","in":"query","description":"Start date timestamp","schema":{"type":"integer"},"required":false},{"name":"end","in":"query","description":"End date timestamp","schema":{"type":"integer"},"required":false}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"NPS aggregated statistic","type":"array","items":{"$ref":"#\/components\/schemas\/NPSStatistic"}}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"id":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f203'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/statistics\/nps\/{popupId}\/aggregated":{"get":{"tags":["Popup statistic"],"summary":"Get NPS statistics","description":"Returns the information about NPS results","parameters":[{"name":"popupId","in":"path","description":"Pop-up ID","schema":{"type":"string","format":"uuid"},"required":true},{"name":"start","in":"query","description":"Start date timestamp","schema":{"type":"integer"},"required":false},{"name":"end","in":"query","description":"End date timestamp","schema":{"type":"integer"},"required":false}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"NPS aggregated statistic","type":"array","items":{"$ref":"#\/components\/schemas\/aggregatedNPSStatistic"}}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"id":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f203'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/tariff\/limits":{"get":{"tags":["Tariff"],"summary":"Get info about user tariff plan","description":"Returns the information about user tariff plan","responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"description":"Tariff info","type":"array","items":{"$ref":"#\/components\/schemas\/userPlanInfo"}}},"type":"object"}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/subscribers\/get\/{subscriberId}":{"get":{"tags":["Subscribers"],"summary":"Get subscriber","description":"Returns detailed info about subscriber","parameters":[{"name":"subscriberId","in":"path","description":"Subscriber ID","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"$ref":"#\/components\/schemas\/subscriber"}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"widgetId":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f20'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"403":{"$ref":"#\/components\/schemas\/accessDeniedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/subscribers\/by-popup\/{popupId}":{"get":{"tags":["Subscribers"],"summary":"Get subscriber by popup","description":"Returns list of subscribers for popup","parameters":[{"name":"popupId","in":"path","description":"Popup ID","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/subscriber"}}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"widgetId":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f20'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"403":{"$ref":"#\/components\/schemas\/accessDeniedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}},"\/public\/api\/subscribers\/by-project\/{projectId}":{"get":{"tags":["Subscribers"],"summary":"Get subscriber by project","description":"Returns list of subscribers for project","parameters":[{"name":"projectId","in":"path","description":"Project ID","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"Operation successful","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/subscriber"}}},"type":"object"}}}},"400":{"description":"Validation error","content":{"application\/json":{"example":{"result":false,"errors":{"widgetId":"Invalid id {{'7803a6ea-4b32-44d7-a245-5cda4e4f20'}}"}}}}},"401":{"$ref":"#\/components\/schemas\/unauthorizedResponse"},"403":{"$ref":"#\/components\/schemas\/accessDeniedResponse"},"404":{"description":"Resource Not Found"}},"security":[{"oAuth2ClientCredentials":[]}]}}},"components":{"schemas":{"project":{"title":"Project","properties":{"id":{"type":"string","format":"uuid","description":"Project ID"},"name":{"type":"string","description":"Project name"},"urls":{"type":"array","items":{"type":"string","format":"uri"},"description":"Project website URL"},"domains":{"type":"array","items":{"type":"string","format":"hostname"},"description":"Project site domains"},"integrationCode":{"type":"string","description":"Code that allows you to install a project on your website"},"updatedAt":{"type":"string","example":"2023-08-07 20:14:15","description":"The date and time your project was last updated. Output in the YYYY-MM-DD hh: mm: ss format with a decimal fraction of a second and time zone designator."},"createdAt":{"type":"string","example":"2023-08-07 20:14:15","description":"The date and time your project was created. Output in the YYYY-MM-DD hh: mm: ss format with a decimal fraction of a second and time zone designator."}},"type":"object"},"popup":{"title":"Popup","properties":{"id":{"type":"string","format":"uuid","description":"Project ID"},"widgetId":{"type":"string","format":"uuid","description":"Pop-up ID"},"isEnabled":{"type":"boolean","description":"Sets a pop-up state. If you want to show your pop-up, pass \"true\", and if you want to hide it, pass \"false\"."},"type":{"type":"integer","enum":[1,2,3,4,5,6,7,8],"description":"Popup type:\n * `2` - modal window;\n * `3` - overlay;\n * `4` - floating;\n * `5` - cookie request;\n * `6` - horizontal;\n * `7` - video;\n * `8` - launcher.\n"},"style":{"type":"integer","enum":[1,2,3],"description":"Popup style:\n * `1` - white;\n * `2` - dark;\n * `3` - colored.\n"},"position":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11],"description":"Popup position:\n * `1` - bottom-left;\n * `2` - bottom-right;\n * `3` - automatic;\n * `4` - bottom;\n * `5` - bottom-center;\n * `6` - left;\n * `7` - right;\n * `8` - center;\n * `9` - top-left;\n * `10` - top-right;\n * `11` - top-center.\n"},"text":{"type":"string","nullable":true,"description":"Text message"},"name":{"type":"string","description":"Pop-up name"},"color":{"type":"string","nullable":true,"description":"Button style color"},"image":{"properties":{"url":{"type":"string","description":"URL of your image uploaded to the SendPulse file manager"},"position":{"type":"integer","enum":[1,2,3,4],"description":"Popup image position:\n * `1` - left;\n * `2` - right;\n * `3` - top;\n * `4` - background.\n"}},"type":"object"},"video":{"properties":{"url":{"type":"string","description":"URL of your video uploaded to the SendPulse file manager"},"format":{"type":"integer","description":"Video format:\n * `1` - vertical;\n * `2` - horizontal.\n"},"playbackType":{"type":"integer","description":"Video playing image:\n * `1` - automatic;\n * `2` - on click.\n"}},"type":"object"},"containsNPS":{"type":"boolean","description":"Show of popup contains NPS"},"statistic":{"title":"Popup statistic","properties":{"peopleReached":{"type":"integer","description":"The number of times your widget was viewed"},"engagements":{"type":"integer","description":"The number of visitors who interacted with your widget, expanded it, read its message, clicked its button, and followed the link."},"subscriptions":{"type":"integer","description":"The number of email addresses or phone numbers customers entered in the \"Email Address Request\" or \"Phone Number Request\" form."},"formEngagements":{"type":"integer","description":"The number of leads who submitted your form"},"wereClosed":{"type":"integer","description":"The number of visitors who closed your widget (clicked the \"cross\" icon)."}},"type":"object"},"preview":{"type":"string","description":"Preview image url"},"abtest":{"title":"AB test information","properties":{"status":{"type":"integer","description":"AB test status. Possible variants: * `0` - finished; * `1` - active.\n"},"finishInitiator":{"type":"integer","description":"AB test finish initiator. Possible values: * `1` - manal (by user); * `2` - auto (reached finish condition).\n"},"finishCondition":{"type":"array","description":"List of finish conditions for AB test","items":{"properties":{"trigger":{"type":"integer","description":"Trigger for AB test finish. Possible values: * `1` - by date (timestamp in value); * `2` - by views (peopleReached); * `3` - by subscriptions.\n"},"value":{"type":"integer","description":"Max value for trigger"}},"type":"object"}},"winner":{"type":"string","description":"Winner variant ID. Empty if test not finished yet."},"separatedConditions":{"type":"boolean","description":"True if variants use different show conditions."},"statistic":{"properties":{"peopleReached":{"type":"integer","description":"Total amount of views for both variants"},"subscriptions":{"type":"integer","description":"Total amount of subscriptions for both variants"}},"type":"object"},"participants":{"properties":{"A":{"properties":{"id":{"type":"string"},"preview":{"type":"string","description":"Preview image url"},"statistic":{"properties":{"peopleReached":{"type":"integer","description":"Total amount of views"},"subscriptions":{"type":"integer","description":"Total amount of subscriptions"}},"type":"object"}},"type":"object"},"B":{"properties":{"id":{"type":"string"},"preview":{"type":"string","description":"Preview image url"},"statistic":{"properties":{"peopleReached":{"type":"integer","description":"Total amount of views"},"subscriptions":{"type":"integer","description":"Total amount of subscriptions"}},"type":"object"}},"type":"object"}},"type":"object"},"createdAt":{"type":"string","example":"2023-08-07 20:14:15","description":"The date and time your AB test was created. Output in the YYYY-MM-DD hh: mm: ss format with a decimal fraction of a second and time zone designator."}},"type":"object"},"updatedAt":{"type":"string","example":"2023-08-07 20:14:15","description":"The date and time your project was last updated. Output in the YYYY-MM-DD hh: mm: ss format with a decimal fraction of a second and time zone designator."},"createdAt":{"type":"string","example":"2023-08-07 20:14:15","description":"The date and time your project was created. Output in the YYYY-MM-DD hh: mm: ss format with a decimal fraction of a second and time zone designator."}},"type":"object"},"popupStatistic":{"title":"Popup statistic","properties":{"peopleReached":{"type":"integer","description":"The number of times your widget was viewed"},"engagements":{"type":"integer","description":"The number of visitors who interacted with your widget, expanded it, read its message, clicked its button, and followed the link."},"subscriptions":{"type":"integer","description":"The number of email addresses or phone numbers customers entered in the \"Email Address Request\" or \"Phone Number Request\" form."},"formEngagements":{"type":"integer","description":"The number of leads who submitted your form"},"wereClosed":{"type":"integer","description":"The number of visitors who closed your widget (clicked the \"cross\" icon)."}},"type":"object"},"NPSStatistic":{"title":"NPS variant statistic","properties":{"button":{"title":"NPS button base information","properties":{"id":{"type":"string","format":"UUID","description":"Uniq ID"},"caption":{"type":"string"},"contactVariableName":{"type":"string","description":"Variable name from CRM"},"variants":{"type":"array","items":{"properties":{"title":{"type":"string","description":"Variant display name"},"option":{"type":"string","description":"Variant value"}},"type":"object"}},"variantsCount":{"type":"integer","description":"Total amount of variants"},"displayType":{"type":"integer","description":"NPS variants display type"}},"type":"object"},"date":{"type":"string"},"option":{"type":"string","description":"Variant value"},"total":{"type":"integer","description":"Total amount of voices for this variant"}},"type":"object"},"aggregatedNPSStatistic":{"title":"Aggregated NPS statistic","properties":{"average":{"type":"integer","description":"NPS score"},"total":{"type":"integer","description":"Total number of results"},"promoter":{"type":"integer","description":"Total promoters"},"neutral":{"type":"integer","description":"Total neutral"},"critic":{"type":"integer","description":"Total critic"},"promoterPercent":{"type":"integer","description":"Percent of promoters"},"neutralPercent":{"type":"integer","description":"Percent of neutrals"},"criticPercent":{"type":"integer","description":"Percent of critics"}},"type":"object"},"projectStatistic":{"title":"Project statistic","properties":{"peopleReached":{"type":"integer","description":"The number of times your widget was viewed"},"engagements":{"type":"integer","description":"The number of visitors who interacted with your widget, expanded it, read its message, clicked its button, and followed the link."},"subscriptions":{"type":"integer","description":"The number of email addresses or phone numbers customers entered in the \"Email Address Request\" or \"Phone Number Request\" form."},"formEngagements":{"type":"integer","description":"The number of leads who submitted your form"},"wereClosed":{"type":"integer","description":"The number of visitors who closed your widget (clicked the \"cross\" icon)."},"widget":{"type":"integer","description":"The number of visitors who use widget buttons."}},"type":"object"},"pageInfo":{"title":"Page Info","properties":{"total":{"type":"integer","description":"Total number of records"},"offset":{"type":"integer","description":"Limit on the number of displayed records"},"first":{"type":"integer","description":"Record count offset"},"arguments":{"type":"object"}},"type":"object"},"scenarioSetting":{"title":"Display condition","properties":{"groupId":{"type":"integer","description":"Behavior group:\n * `1` - frequency;\n * `2` - time;\n * `3` - user behavior;\n * `4` - clicks;\n * `5` - pages and urls;\n * `6` - utm parameters;\n * `7` - visitor data.\n"},"dataType":{"type":"string","description":"Data type"},"name":{"type":"string","description":"Condition name"},"uniq":{"type":"boolean","description":"Is unique"}},"type":"object"},"userPlanInfo":{"title":"Tariff info","properties":{"expiredAt":{"type":"string","description":"Expiring date"},"daysAmount":{"type":"integer","description":"Tariff length in days"},"currentDaysAmount":{"type":"integer","description":"Used days for this moment"},"daysLeft":{"type":"integer","description":"Days left"},"nextLimitsDrop":{"type":"string","description":"Date for monthly limits drop"},"options":{"type":"object","properties":{"views":{"type":"object","properties":{"amount":{"type":"integer","description":"Total available amount"},"amountLeft":{"type":"integer","description":"Left amount"},"currentAmount":{"type":"integer","description":"Used amount"}}}},"description":"Tariff limits info"}},"type":"object"},"subscriber":{"title":"Subscriber","properties":{"id":{"type":"integer","description":"Subscriber id"},"clientId":{"type":"string","description":"Id formed in browser"},"name":{"type":"string","nullable":true},"projectId":{"type":"string"},"popupId":{"type":"string"},"gender":{"type":"integer","description":"Available values:\n * `0` - unknown;\n * `1` - male;\n * `2` - female.\n"},"email":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"type":"object"},"unauthorizedResponse":{"description":"Unauthorized"},"accessDeniedResponse":{"description":"Access denied"}},"securitySchemes":{"oAuth2ClientCredentials":{"type":"oauth2","description":"","flows":{"clientCredentials":{"tokenUrl":"https:\/\/api.sendpulse.com\/oauth\/access_token","scopes":[]}}}}},"tags":[{"name":"Project"},{"name":"Project statistic"},{"name":"Popup"},{"name":"Popup statistic"}],"security":[{"oAuth2ClientCredentials":[]}]}