Insider One's REST APIs provide you the ability to manage your user data and product catalog, send messages, and export data.
\nYou can call Insider One's various APIs from your end to create, delete, update, and read data on Insider One's end. Using these APIs, you can send messages to your users, update their data, export your analytics, and perform many other actions.
\nInsider One also provides Webhooks to manage Insider One's Unified Customer Database, Email, SMS, and Mobile App capabilities. To get a better understanding of the difference between an API and a Webhook, refer to Webhooks vs APIs.
\nIf you need any assistance for your new/existing API integrations, you can create an Integration Support ticket and reach out to the Insider One team.
\nUsing Insider One's APIs, you can perform many actions based on your use cases. For example, you can create and send web push notifications to your opt-in users, or unify your users' online data with their offline purchase data. See below for the available categorized actions:
\nUser Data APIs
\nData Governance APIs
\nUser Subscription APIs
\nMessaging APIs
\nProduct Catalog APIs
\nSearch APIs
\nReports & Analysis APIs
\nTo send a request, you might need the following requirements, depending on the API you are using:
\nInsider One uses authentication to validate and process incoming API calls. Each API request must include an API key—a unique code used to authenticate the request and authorize access.
\nOnly users with Administrator permissions can generate API tokens. If your account does not have the necessary permissions, please contact the Insider One team for assistance.
\nFor security reasons, generated tokens are fully visible only once—immediately after they are created. After that, the full token will no longer be accessible.
We strongly recommend saving the token securely at the time of generation. If needed, you can always generate a new token for your project.
Read more about API Authentication Tokens.
\nSome of the Insider One APIs listed above might require a request token. The Insider One team provides this token for your account.
\nSome of the Insider One APIs listed above might require your partner name. Your partner name is displayed in the dropdown menu next to your user name on your dashboard.
\nYou can also navigate to InOne > Inone Settings > Account Settings to read your partner name.
\nRate limiting controls how many API requests can be made within a defined time window. In large systems, many unintentional denial-of-service (DoS) incidents stem from software bugs or configuration errors rather than malicious attacks. By enforcing rate limits, the system protects itself from overload and ensures stable performance.
\nIf you exceed the allowed number of requests in the given timeframe, the API will respond with an error, typically a 429 Too Many Requests status code.
\nRefer to the API Rate Limits for the specific rate limits applied to Insider One APIs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Scope","slug":"scope"}],"owner":"24851117","collectionId":"6292aab3-56be-4aba-a69a-ab1b4982f5dd","publishedId":"2sB3dSR9bM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-12T11:35:23.000Z"},"item":[{"name":"User Data APIs","item":[{"name":"Upsert user data","id":"31942c05-0d7a-4681-a050-271c8424f231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n {\n \"identifiers\": {\n \"email\": \"sample@mail.com\",\n \"uuid\": \"1x2y3z\",\n \"custom\": {\n \"user_loyalty_id\": \"xyz123\"\n }\n },\n \"attributes\": {\n \"email_optin\": true,\n \"age\": 30,\n \"language\": \"en_US\",\n \"list_id\": [\n 1,\n 2\n ],\n \"birthday\": \"1980-01-01T00:00:00Z\",\n \"custom\": {\n \"loyalty\": \"Gold\"\n }\n },\n \"events\": [\n {\n \"event_name\": \"purchase\",\n \"timestamp\": \"2021-01-10T21:35:20Z\",\n \"event_params\": {\n \"product_id\": \"AGH210070\",\n \"unit_price\": 990.9,\n \"unit_sale_price\": 890.9,\n \"event_group_id\": \"ORDER123\",\n \"taxonomy\": [\n \"Electronic\",\n \"Phone\"\n ],\n \"currency\": \"USD\"\n }\n },\n {\n \"event_name\": \"account_created\",\n \"timestamp\": \"2021-01-17T14:41:21+03:00\",\n \"event_params\": {\n \"custom\": {\n \"customer_type\": \"trial\",\n \"trial_start_date\": \"2021-01-17T14:39:21+03:00\",\n \"trial_end_date\": \"2021-01-24T14:41:21+03:00\"\n }\n }\n }\n ]\n }\n ]\n}"},"url":"https://unification.useinsider.com/api/user/v1/upsert","description":"Upsert API enables you to send users' attributes and events to Insider. It allows you to insert and update user data whenever you need it.
\nYou can possibly use the Upsert User Data for the following use cases:
\nSending offline purchases or any other events
\nSending leads that are collected from any other platform
\nSending segments that are prepared in-house
\nIf you want to limit access to the Upsert API for users with a UCD API Key or control data transmission through this API, you can implement IP restrictions. This ensures that only Upsert API requests from approved IP addresses will be accepted. If you want to make such a custom adjustment, please contact the Insider team.
\nYou should use the Identifier Update API if you want to update an identifier listed in your Identity Resolution Management Settings.
\nYou can send two data types to our data ingestion API: attributes and events.
\nAn attribute is a single, static piece of information about a user, such as gender, age, or loyalty class. When you send data to an array attribute for a user, the new values are added to the existing ones by default. If you don't want to append values but overwrite the array attributes, you need to add \"not_append\": true or \"append\": false to the request. If you use both together, the value you provide for \"append\" will be accepted.
\nAn event is a collection of information, such as purchased products or visited stores. Any update request for an existing user with the same event name will append it to the collection.
\nEach user object must have at least one attributes object or one events object. No default attribute is mandatory. If you use attributes object in the request, you need to have at least one attribute in your object.You can use event group ID to group the events of the same type if you send multiple events of this type.When sending events via the Upsert API, ensure that the values fall within the TTL (Time-to-Live) of the events. Events with timestamps exceeding the TTL will not be written. You can refer to the Data Retention for further information.
\nUsing Upsert API, you can import historical data. While importing historical data, if there is an active Architect On Event element or the data stream is set, and the imported data meets the conditions of the journey and the data stream, the Architect On Event element or data stream can be triggered.
\nFor example, you send the purchase events from one year ago to users with Upsert API. At the same time, if an active Architect journey is set with a purchase condition using the On Event element, users will enter this journey because they meet the condition based on their data from a year ago.
\nA boolean flag called “skip_hook” is available in the Upsert request body to prevent historical data from entering the current journey. Thanks to this flag, you can choose whether to trigger the data stream or use the Architect On Event starter for the imported data.
\nThis flag is not mandatory. If not specified, it is taken as skip_hook: false by default. If you do not want to trigger the data stream, it should be skip_hook: true.
\nIdentifiers must be placed under the identifiers object only. They should not be sent within attributes, events, or any other part of the payload. This structure ensures accurate identity resolution and consistent data processing across the platform.
\nInsider allows these parameters to send:
\nIf your company obtains your users' consent in compliance with the local regulations, make sure to pass the GDPR opt-in field to Insider. If you want to stop collecting and processing the data of an identified user, GDPR opt-in field should have the false value. Insider cannot be held liable if these obligations are not fulfilled and reserves the right to seek compensation from your company.
\nPlease be aware of the limitations while sending your request.
\nThe request body consists of a users array. Each user must have an identifiers object.
\nThe sample request below sends the default purchase event. To see the other default events and event parameters that you can use in your requests, refer to Default Events & Attributes.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/upsert' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: 1a2b3c4e5d6f' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"skip_hook\": false,\n \"users\": [\n {\n \"identifiers\": {\n \"email\": \"sample@useinsider.com\",\n \"uuid\": \"1x2y3z\",\n \"custom\": {\n \"user_loyalty_id\": \"xyz123\"\n }\n },\n \"attributes\": {\n \"email_optin\": true,\n \"age\": 30,\n \"language\": \"en_US\",\n \"static_segment_id\": [\n 1,\n 2\n ],\n \"birthday\": \"1980-01-01T00:00:00Z\",\n \"custom\": {\n \"favorite_color\": [\n \"green\"\n ]\n }\n },\n \"events\": [\n {\n \"event_name\": \"purchase\",\n \"timestamp\": \"2021-01-10T21:35:20Z\",\n \"event_params\": {\n \"product_id\": \"ABC21000\",\n \"name\": \"Your Product Name\",\n \"unit_price\": 990.9,\n \"unit_sale_price\": 890.9,\n \"event_group_id\": \"ORDER123\",\n \"taxonomy\": [\n \"Electronic\",\n \"Phone\"\n ],\n \"currency\": \"USD\",\n \"quantity\": 1\n }\n },\n {\n \"event_name\": \"account_created\",\n \"timestamp\": \"2021-01-17T14:41:21+03:00\",\n \"event_params\": {\n \"custom\": {\n \"customer_type\": \"trial\",\n \"trial_start_date\": \"2021-01-17T14:39:21+03:00\",\n \"trial_end_date\": \"2021-01-24T14:41:21+03:00\"\n }\n }\n }\n ]\n }\n ]\n}'\n\nThe request body below contains insider_id.
\n\n\ninsider id is an internal ID maintained by Insider for each user. To find the insider_id, you can refer to the Profile ID on the User Profiles.
\n
error_callback_endpoint is an endpoint that will notify you if your upset request fails on the Insider's side due to a unification error.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/upsert' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: 1a2b3c4e5d6f' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"skip_hook\": false,\n \"error_callback_endpoint\":\"http://your-error-callback-endpoint.yourdomain.com\",\n \"users\": [\n {\n \"insider_id\": \"sampleinsiderid\",\n \"attributes\": {\n \"email_optin\": true,\n \"age\": 30,\n \"language\": \"en_US\",\n \"list_id\": [\n 1,\n 2\n ],\n \"birthday\": \"1980-01-01T00:00:00Z\",\n \"custom\": {\n \"favorite_color\": [\n \"green\"\n ]\n }\n },\n \"not_append\": true,\n \"events\": [\n {\n \"event_name\": \"purchase\",\n \"timestamp\": \"2021-01-10T21:35:20Z\",\n \"event_params\": {\n \"product_id\": \"ABC21000\",\n \"name\": \"Your Product Name\",\n \"unit_price\": 990.9,\n \"unit_sale_price\": 890.9,\n \"event_group_id\": \"ORDER123\",\n \"taxonomy\": [\n \"Electronic\",\n \"Phone\"\n ],\n \"currency\": \"USD\",\n \"quantity\": 1\n }\n },\n {\n \"event_name\": \"account_created\",\n \"timestamp\": \"2021-01-17T14:41:21+03:00\",\n \"event_params\": {\n \"custom\": {\n \"customer_type\": \"trial\",\n \"trial_start_date\": \"2021-01-17T14:39:21+03:00\",\n \"trial_end_date\": \"2021-01-24T14:41:21+03:00\"\n }\n }\n }\n ]\n }\n ]\n}'\n\nThe request below sends data for two users, each with their own attributes, events, and custom parameters.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/upsert' \\\n --header 'X-PARTNER-NAME: mybrand' \\\n --header 'X-REQUEST-TOKEN: 1a2b3c4e5d6f' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"skip_hook\": false,\n \"error_callback_endpoint\":\"http://your-error-callback-endpoint.yourdomain.com\",\n \"users\": [\n {\n \"insider_id\": \"sampleinsiderid\",\n \"attributes\": {\n \"email_optin\": true,\n \"age\": 30,\n \"language\": \"en_US\",\n \"list_id\": [\n 1,\n 2\n ],\n \"birthday\": \"1980-01-01T00:00:00Z\",\n \"custom\": {\n \"favorite_color\": [\n \"green\"\n ]\n }\n },\n \"not_append\": true,\n \"events\": [\n {\n \"event_name\": \"purchase\",\n \"timestamp\": \"2021-01-10T21:35:20Z\",\n \"event_params\": {\n \"product_id\": \"ABC21000\",\n \"name\": \"Your Product Name\",\n \"unit_price\": 990.9,\n \"unit_sale_price\": 890.9,\n \"event_group_id\": \"ORDER123\",\n \"taxonomy\": [\n \"Electronic\",\n \"Phone\"\n ],\n \"currency\": \"USD\",\n \"quantity\": 1\n }\n },\n {\n \"event_name\": \"account_created\",\n \"timestamp\": \"2021-01-17T14:41:21+03:00\",\n \"event_params\": {\n \"custom\": {\n \"customer_type\": \"trial\",\n \"trial_start_date\": \"2021-01-17T14:39:21+03:00\",\n \"trial_end_date\": \"2021-01-24T14:41:21+03:00\"\n }\n }\n }\n ]\n },\n {\n \"insider_id\": \"sampleinsiderid_2\",\n \"attributes\": {\n \"email_optin\": true,\n \"age\": 23,\n \"language\": \"en_US\",\n \"list_id\": [\n 1,\n 2\n ],\n \"birthday\": \"1996-08-08T00:00:00Z\",\n \"custom\": {\n \"favorite_color\": [\n \"blue\"\n ]\n }\n },\n \"not_append\": true,\n \"events\": [\n {\n \"event_name\": \"purchase\",\n \"timestamp\": \"2024-01-10T21:35:20Z\",\n \"event_params\": {\n \"product_id\": \"CYD21000\",\n \"name\": \"Your Product Name\",\n \"unit_price\": 990.9,\n \"unit_sale_price\": 890.9,\n \"event_group_id\": \"ORDER123\",\n \"taxonomy\": [\n \"Electronic\",\n \"Phone\"\n ],\n \"currency\": \"USD\",\n \"quantity\": 1\n }\n },\n {\n \"event_name\": \"account_created\",\n \"timestamp\": \"2022-02-17T14:41:21+03:00\",\n \"event_params\": {\n \"custom\": {\n \"customer_type\": \"trial\",\n \"trial_start_date\": \"2021-04-17T14:39:21+03:00\",\n \"trial_end_date\": \"2021-04-24T14:41:21+03:00\"\n }\n }\n }\n ]\n }\n ]\n }'\n\nIf some attributes or parameters are not reflected, the issue is likely related to the request structure or the data being sent. As a solution, check the request structure using a sample payload and ensure that the data types match the values you are trying to send. If the problem persists, feel free to contact the Insider team.
\nIf none of the attributes, events, or parameters are reflected, or if the user profile is not created after a few hours of sending the request, please reach out to the Insider team.
\nThis response indicates that the event_group_id and unit_sale_price parameters are included together in the request for the purchase event.
\n{\n \"data\": {\n \"successful\": {},\n \"fail\": {\n \"count\": 1,\n \"errors\": {\n \"users.0.events.0.event_params.*.required\": [\n \"event_group_id parameter is required on purchase event\",\n \"unit_sale_price parameter is required on purchase event\"\n ]\n }\n }\n }\n}\n\nFor the request below, you need to use an identifier for the user, which can be either insider_id or UUID, email or phone number, or a custom attribute. Besides, you can also send these attributes as attributes if any one of them is not an identifier.
\n{\n \"data\": {\n \"successful\": {},\n \"fail\": {\n \"count\": 1,\n \"errors\": {\n \"users.0.events.0.event_params.*.required\": [\n \"event_group_id parameter is required on purchase event\",\n \"unit_sale_price parameter is required on purchase event\"\n ],\n \"users.0.identifiers.required\": [\n \"either insider_id or idenifiers must be specified\"\n ],\n \"users.0.insider_id.required\": [\n \"either insider_id or idenifiers must be specified\"\n ]\n }\n }\n }\n}\n\nFor the request below, you need to have a valid email address in the format stated in the parameters table.
\n{\n \"data\": {\n \"successful\": {},\n \"fail\": {\n \"count\": 1,\n \"errors\": {\n \"users.0.events.0.event_params.*.required\": [\n \"event_group_id parameter is required on purchase event\",\n \"unit_sale_price parameter is required on purchase event\"\n ],\n \"users.0.identifiers.*.regexp(^.+@.+\\\\..+$)\": [\n \"not a valid email address: sample\"\n ]\n }\n }\n }\n}\n\nFor the request below, you need to have the valid UUID in the format stated in the parameters table.
\n{\n \"data\": {\n \"successful\": {},\n \"fail\": {\n \"count\": 1,\n \"errors\": {\n \"users.0.events.0.event_params.*.required\": [\n \"event_group_id parameter is required on purchase event\",\n \"unit_sale_price parameter is required on purchase event\"\n ],\n \"users.0.identifiers.*.type(string)\": [\n \"uuid must be string: 12345\"\n ]\n }\n }\n }\n}\n\nFor the request below, you need to have the valid identifier in the format stated in the parameters table.
\n{\n \"data\": {\n \"successful\": {},\n \"fail\": {\n \"count\": 1,\n \"errors\": {\n \"users.0.events.0.event_params.*.required\": [\n \"event_group_id parameter is required on purchase event\",\n \"unit_sale_price parameter is required on purchase event\"\n ],\n \"users.0.identifiers.*.in(defaults_column)\": [\n \"key must be one of phone_number(pn), email(em) or uuid\"\n ]\n }\n }\n }\n}\n\nFor the request below, you need to have a valid phone number in the format stated in the parameters table.
\n{\n \"data\": {\n \"successful\": {},\n \"fail\": {\n \"count\": 1,\n \"errors\": {\n \"users.0.events.0.event_params.*.required\": [\n \"event_group_id parameter is required on purchase event\",\n \"unit_sale_price parameter is required on purchase event\"\n ],\n \"users.0.identifiers.*.regexp(^\\\\+[1-9]\\\\d{6,14}$)\": [\n \"user has an invalid phone number: 12345\"\n ]\n }\n }\n }\n}\n\nIf you do not include user in your request, you receive an error shown below:
\n{\"error\":\"users must be defined: bad request\"}\n\nIf you exceed the rate limits, you receive an error shown below:
\n{\n \"error\": \"rejected: too many requests\"\n}\n\nIf this error occurs, consider implementing retries and reviewing your connection configuration to remain within the Upsert API's rate limits. Not retrying may prevent some data from being successfully applied.
\n400 Bad Request
\n500 Internal Server Error
\n403 Forbidden
\nIf you receive a 403 response instead of 200 OK, stop or pause the current data sending. Check your headers, which are your partner name, and token, and correct any errors. Once the issues are fixed, resume your integration and retry the failed requests. If your headers are correct but you continue to encounter issues, please create a ticket for the Insider team.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new data can be inserted and updated with this API. No data can be retrieved.
\nThe request token should be provided in the request header. If the token is incorrect, no operation will be executed.
\nThe entire request must not exceed 5 MB.
\nEach request can upsert the data for a maximum of 1,000 records (user).
\nThe rate limit is shared with the Delete User Attribute, allowing a total of 25,000 requests per minute, which means you can process up to 25 million user records per minute with full batching.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"*\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"email_click\",\n \"params\": [\n \"campaign_id\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"format\": \"parquet\",\n \"hook\": \"xyz.test.com\"\n}"},"url":"https://unification.useinsider.com/api/raw/v1/export","description":"This API prepares the raw user data, exports it into Insider's AWS S3 Bucket, and returns a link to your webhook endpoint as a response. This link enables you to access the raw user data and transfer it to your end.
\nThe API prepares the raw user data for all users for all requested attributes and for a list of events and their event parameters. You can filter to narrow down the user set (e.g., the raw user data can return the users who made a purchase on the last day).
\nThe API can prepare the raw data for attributes and events together. You can choose the events you will receive and the attributes that will be added to each event entry.
\nSuggested Reading: Understanding Events and Attributes
\nYou should provide a webhook endpoint in the request to be notified when the export link is ready. After sending a request, your webhook endpoint receives an export link as follows to have access to the raw user data.
\nhttps://insider-data-export.useinsider.com/{partner name}/p/{file name}
\nYou can export raw user data to analyze user information using a business intelligence tool and sync the data that you want via daily jobs.
\nUsing the Export API, Insider sends the file as a link via Webhook to your endpoint. Export files are sent from specific Insider IP addresses. To enhance security, whitelist Insider IP addresses on your system to restrict access to your endpoint. Remember that whitelisting our IP addresses is about restricting access to your endpoint, which ensures only approved sources can access your endpoint. To add our IP addresses to your approved list for whitelisting, reach out to the Insider team.
\nIt might take several hours to receive the file after you get the 200 response. If there is an issue with the file size while exporting, you will be notified. In this case, try exporting the data in a smaller range. If you still do not receive the export link, we highly suggest checking if your endpoint is publicly accessible and functioning properly.
\nThe Raw Export logs events based on their actual timestamp, regardless of when they are recorded in the User Content Database (UCD). In contrast, the S3 Export captures events within specific intervals, like the past hour, according to their UCD entry time. For example, the event counts displayed on the Metadata Analytics page represent all transmissions sent to UCD. Sending the same event 100 times results in only one entry in the database but shows a transmission count of 100 on the page, while Raw Export will show only 1. If an event was timestamped three days ago but sent today, it will appear in S3 Export based on the current transmission timeframe, like the last hour.
\nBefore starting the implementation, make sure to share the following information with your Insider Technical Account Manager:
\nA webhook endpoint that will be notified when the export link is ready
\nA preferred format: CSV or Parquet
\nA list of attributes, events, and event parameters that you want to export
\nA dynamic segment that you want to export
\nYou can consult the Insider team on which parameters to add to the request.
\nThe date range of the segments in requests to the Raw Export API must align with the date range of the requested events. For example, if you're requesting data for the last 5 days of a segment, the event date range should also cover that same period. If the event date range is set to only 2 days, data for users who entered the segment in the last 3 days will not appear in the export.
\nEach request must have attributes or events object to return the respective user profiles. If you are using an events object, its keys are required, as stated in the table below.
\nThe sample below displays a request to get the raw user data with all attributes.
\n{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"*\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"email_click\",\n \"params\": [\n \"email_campaign_id\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"format\": \"parquet\",\n \"hook\": \"xyz.test.com\"\n}\n\nThe sample below displays a request to get the raw user data with selected attributes.
\n{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"last_visited_product\",\n \"email\",\n \"name\",\n \"c_custom_attribute\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"custom_event\",\n \"params\": [\n \"c_custom_parameter\",\n \"timestamp\"\n ],\n \"filters\": [\n {\n \"key\": \"email_campaign_id\",\n \"operator\": \"eq\",\n \"values\": [369, 877]\n }\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"format\": \"parquet\",\n \"hook\": \"https://xyz.test.com\"\n}\n\nThe following response returns if the request is successful.
\n{\"url\":\"https://insider-data-export.useinsider.com/{partner name}/p/{file name}\"}\n\nThe following response returns if you exceed the rate limit.
\n{\n \"error\": \"rejected: too many requests\"\n}\n\nWhen sending your request, make sure to follow these limitations:
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly a response that states whether the request is successful or failed can be received via this API. No data can be inserted.
\nThe request token should be provided in the request header. If the token is incorrect, the operation will not be executed.
\nThe exported data can be in CSV, Parquet (version 1.0), or JSON formats.
\nThe export link expires in 24 hours after it is ready.
\nThe rate limit for raw export is 1 request per day. Failed requests don't count. Based on the UTC zone, the API can be called only once in 24 hours. The limitation timeline resets at UTC 00:00.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nSince https://webhook.site blocks Insider, you cannot retrieve hooks containing download links with URLs belonging here. We will make efforts to address this issue; however, there are currently limitations to resolving it.
\n","urlObject":{"protocol":"https","path":["api","raw","v1","export"],"host":["unification","useinsider","com"],"query":[],"variable":[]}},"response":[{"id":"2dd92dd3-2f47-4fc1-9c91-156aa722cf6e","name":"Export users from a dynamic segment by an attribute and event","originalRequest":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"segment\": {\n \"segment_id\": 116731\n },\n \"attributes\": [\n \"city\"\n ],\n \"events\": {\n \"start_date\": 1682951197,\n \"end_date\": 1685111197,\n \"wanted\": [\n {\n \"event_name\": \"listing_page_view\",\n \"params\": [\n \"device_type\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"format\": \"csv\",\n \"hook\": \"http://{IP_ADRESS}:{PORT_NUBER}/slack_hook/xxxxxxxxxxEXAMPLExxxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":"https://unification.useinsider.com/api/raw/v1/export"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Fri, 26 May 2023 14:28:37 GMT","enabled":true},{"key":"Content-Length","value":"0","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"vary","value":"Origin","enabled":true},{"key":"x-envoy-upstream-service-time","value":"7","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Set-Cookie","value":"__cf_bm=g24b8shcUMjPoZmWgVh9L.7aH9ogtCVJb4ddGcpeLPc-1685111317-0-AXnBF2j8EJQfDZBG0XfuPdlDuJqpjOoIEcncIzriCKq6No5mvTYX06YgAk9hhLReF9w6Htns7f92F2ZH2kTtaH4=; path=/; expires=Fri, 26-May-23 14:58:37 GMT; domain=.useinsider.com; HttpOnly; Secure; SameSite=None","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cd6b4a48d408f1d-IAD","enabled":true}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4f3fdcf2-4108-4398-bd84-ba75ce0aa88e"},{"name":"Delete user attribute","id":"62b5e0dc-0959-4f47-b372-227e450ed9dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n {\n \"identifiers\": {\n \"email\": \"sample@mail.com\",\n \"uuid\": \"1x2y3z\",\n \"custom\": {\n \"custom_identifier\": \"xyz123\"\n }\n },\n \"whole\": [\n \"name\",\n \"surname\",\n \"email_optin\"\n ],\n \"partial\": {\n \"list_id\": [\n 1,\n 2\n ]\n },\n \"custom\": {\n \"whole\": [\n \"custom_string_attribute\",\n \"custom_array_attribute\"\n ],\n \"partial\": {\n \"custom_array_attribute\": [\n \"value1\",\n \"value2\",\n \"value3\"\n ]\n }\n }\n }\n ]\n}"},"url":"https://unification.useinsider.com/api/user/v1/attribute/delete","description":"This API enables you to delete your customer attributes when you need to. You can either delete the whole attribute from the user, or delete a specific value from an array typed attribute.
\nFor example, your customer might have selected GDPR’s “right-to-be-forgotten” option and you need to delete some attributes that capture such customer information.
\nThis deletion action cannot be undone. Please carefully consider before proceeding.
\nAn attribute defined as an identifier cannot be deleted with this request. To delete this type of attribute (since it functions as an identifier), you must use the Delete Identifiers API.
\nEach POST body must have a unifier field under identifiers object. You can use the default identifiers such as email, phone number, or uuid and also the custom identifier to define a unifier.
\nThe following is a sample JSON to delete user attributes.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/attribute/delete' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"users\": [\n {\n \"identifiers\": {\n \"email\": \"sample@useinsider.com\",\n \"uuid\": \"1x2y3z\",\n \"custom\": {\n \"custom_identifier\": \"xyz123\"\n }\n },\n \"whole\": [\n \"name\",\n \"surname\",\n \"email_optin\"\n ],\n \"partial\": {\n \"list_id\": [\n 1,\n 2\n ]\n },\n \"custom\": {\n \"whole\": [\n \"custom_string_attribute\",\n \"custom_array_attribute\"\n ],\n \"partial\": {\n \"custom_array_attribute\": [\n \"value1\",\n \"value2\",\n \"value3\"\n ]\n }\n }\n }\n ]\n}'\n\nThe sample below displays a request to get user data with insider_id.
\ninsider_id is an internal ID maintained by the Insider for each user. To find the insider_id, you can refer to the Profile ID on the User Profile.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/attribute/delete' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"users\": [\n {\n \"insider_id\": \"sampleinsiderid\",\n \"whole\": [\n \"name\",\n \"surname\",\n \"email_optin\"\n ],\n \"partial\": {\n \"list_id\": [\n 1,\n 2\n ]\n },\n \"custom\": {\n \"whole\": [\n \"custom_string_attribute\",\n \"custom_array_attribute\"\n ],\n \"partial\": {\n \"custom_array_attribute\": [\n \"value1\",\n \"value2\",\n \"value3\"\n ]\n }\n }\n }\n ]\n}'\nThe following response returns if the request is successful.
\n{}\n\nThe following response returns in case of an authentication error.
\n{\n \"success\": false,\n \"message\": \"Access Denied. You do not have sufficient access to perform this action.\"\n}\n\nThe following response returns if you exceed the rate limit.
\n{\n \"error\": \"rejected: too many requests\"\n}\n\n{\n \"success\": false,\n \"message\": \"The request processing has failed because of an unknown error.\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly delete requests can be sent via this API. No data can be retrieved.
\nThe request token should be provided in the request header. If the token is incorrect, the operation will not be executed.
\nA single HTTPS POST request can pass a maximum of 1,000 records (users).
\nRate limit is shared with User Upsert API with a total of 25,000 requests per minute.
\nThe entire request must not exceed 5 MB.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"old_identifier\": {\n \"email\": \"sample@mail.com\"\n },\n \"new_identifier\": {\n \"email\": \"sample2@mail.com\"\n }\n}"},"url":"https://unification.useinsider.com/api/user/v1/identity","description":"This API enables you to update the value of the identifiers that are already associated with users.
\nFor example, an existing user that is already a known user to Insider may have updated their email address in your system. Accordingly, you may need to change the identifier(s) of this user. With this API, you can change the value of an existing identifier to a new value.
\nEach PATCH request must have an identifier type, old value, and new value specified in it. You can use either one of the default identifiers which are uuid, email, and phone_number, or any one of the custom identifiers you are using.
\nBelow is a sample body with default identifiers.
\n{\n \"old_identifier\": {\n \"email\": \"sample@mail.com\"\n },\n \"new_identifier\": {\n \"email\": \"sample2@mail.com\"\n }\n}\n\nBelow is a sample body with custom identifiers.
\n{\n \"old_identifier\": {\n \"custom\": {\n \"user_loyalty_id\": \"xyz123\"\n }\n },\n \"new_identifier\": {\n \"custom\": {\n \"user_loyalty_id\": \"xyz123\"\n }\n }\n}\n\nThe following response returns if the identifier values are the same.
\n{\n \"error\": \"identifier values are the same: bad request\"\n}\n\nThe following response returns if you do not have 1 entry for both new and old identifiers.
\n{\n \"error\": \"there must be exactly 1 entry for both new and old identifiers: bad request\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS PATCH request.
\nThe request token should be provided in the request header. If the token is incorrect, no operation will be executed.
\nA single HTTPS PATCH request can pass only one record (user).
\nA maximum of 2000 requests can be sent per minute.
\nIdentifiers that are to be replaced should be of the same type.
\nThe entire request must not exceed 5 MB.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identifiers\": {\n \"email\": \"sample@mail.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://unification.useinsider.com/api/user/v1/identity","description":"This API enables you to delete the value of the identifiers that are already associated with users.
\nFor example, an existing user that is already a known user to Insider may have deleted their phone number from your system. Accordingly, you may need to delete the phone number of this user. With this API, you can delete the value of an existing identifier.
\nThis deletion action cannot be undone. Please carefully consider before proceeding.
\nEach DELETE request must have an identifier type, and the value specified in it. You can use either one of the default identifiers, which are uuid, email, and phone_number, or any one of the custom identifiers you are using.
\nIf the user is associated with only one identifier, you cannot delete it.
\nBelow is a sample body with a default identifier.
\n{\n \"identifiers\": {\n \"email\": \"sample@mail.com\"\n }\n}\n\nBelow is a sample body with a custom identifier.
\n{\n \"identifiers\": {\n \"custom\": {\n \"user_loyalty_id\": \"xyz123\"\n }\n }\n}\n\nThe following response returns if the user has only one identifier.
\n{\n \"error\": \"you cannot delete the sole identifier specified for a user: bad request\"\n}\n\nIf you exceed the rate limits, you receive an error shown below:
\n{\n \"error\": \"rejected: too many requests\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS DELETE request.
\nThe request token should be provided in the request header. If the token is incorrect, no operation will be executed.
\nA single HTTPS DELETE request can pass only 1 record (user).
\nA maximum of 25,000 requests can be sent per minute.
\nIdentifier that are to be deleted cannot be the only identifier associated with the corresponding user profile.
\nThe entire request must not exceed 5 MB.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identifiers\": {\n \"email\": \"johndoe@email.com\"\n },\n \"attributes\": [\n \"email\",\n \"name\",\n \"surname\",\n \"custom\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"email_click\",\n \"params\": [\n \"campaign_id\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"quota\": true\n}"},"url":"https://unification.useinsider.com/api/user/v1/profile","description":"This API returns the attributes and events you request for a single user that you specify by an identifier. It takes identifier, attribute list, and event list within the date range. In its response, it provides the data you choose.
\nYou can get user profiles for various use cases. For example, you can personalize the content for your other providers, or connect user profiles to your services like call centers.
\nEach POST body must have an identifiers object.
\nEach request must have attributes or events object to return the respective user profiles. In the event of using events object, its keys are required as stated in the table below.
\nSpecifically for this API, to select the journey event's name parameter, use journey_campaign_name as the event parameter key.
\nThe sample below displays a request to get user data with an identifier.
\nYou can refer to Default Events & Attributes to see the list of events and attributes. If an event or attribute name consists of more than one word, you can use an underscore (_) between the words. E.g. email_optin, homepage_view, etc.
\n{\n \"identifiers\": {\n \"email\": \"sample@useinsider.com\"\n },\n \"attributes\": [\n \"email\",\n \"name\",\n \"surname\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"email_click\",\n \"params\": [\n \"campaign_id\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"quota\": true\n}\n\nThe sample below displays a request to get user data with a custom attribute. For custom attributes, you need to add a “_c__” prefix.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/profile' \\\n--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'Content-Type: application/json' \\\n--header 'Cookie: __cfduid=d1a0bc0c8335c7fecbd3485839787329b1615112066' \\\n--data-raw '{\n \"identifiers\": {\n \"email\": \"example@useinsider.com\"\n },\n \"attributes\": [\n \"email\",\n \"name\",\n \"surname\",\n \"c_member_code\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"email_click\",\n \"params\": [\n \"campaign_id\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"quota\": true\n}' \n\nThe sample below displays a request to get user data with insider_id.
\ninsider_id is an internal ID maintained by the Insider for each user. To find the insider_id, you can refer to the Profile ID on the User Profile.
\ncurl --location --request POST 'https://unification.useinsider.com/api/user/v1/profile' \\\n--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'Content-Type: application/json' \\\n--header 'Cookie: __cfduid=d1a0bc0c8335c7fecbd3485839787329b1615112066' \\\n--data-raw '{\n \"insider_id\": \"sampleinsiderid\",\n \"attributes\": [\n \"email\",\n \"name\",\n \"surname\"\n ],\n \"events\": {\n \"start_date\": 1606311893,\n \"end_date\": 1611582293,\n \"wanted\": [\n {\n \"event_name\": \"email_click\",\n \"params\": [\n \"campaign_id\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"item_added_to_cart\",\n \"params\": [\n \"product_id\",\n \"name\",\n \"timestamp\"\n ]\n },\n {\n \"event_name\": \"journey_entered\",\n \"params\": [\n \"journey_id\",\n \"timestamp\"\n ]\n }\n ]\n },\n \"quota\": true\n}'\n\nThe following response returns if the request is successful.
\n{\n \"attributes\": {\n \"email\": \"example@useinsider.com\",\n \"name\": \"John\",\n \"surname\": \"Doe\"\n \"iid\": \"insider-id-user-1\"\n },\n \"events\": {\n \"email_click\": [\n {\n \"campaign_id\": 1456,\n \"created_date\": \"2021-01-06T23:34:09Z\"\n },\n {\n \"campaign_id\": 1245,\n \"created_date\": \"2021-01-01T12:56:21Z\"\n }\n ],\n \"item_added_to_cart\": [\n {\n \"product_id\": \"3254634\",\n \"name\": \"Blue Shirt\",\n \"created_date\": \"2021-01-04T15:04:34Z\"\n }\n ],\n \"journey_entered\": [\n {\n \"journey_id\": 12,\n \"created_date\": \"2021-01-02T09:35:46Z\"\n }\n ]\n },\n \"quota\": {\n \"cost\": 2.5,\n \"used\": 2.5,\n \"total\": 1000\n }\n}\n\nThe following response returns if no user is found for the respective identifier.
\n{\"error\":\"no such user for these identifiers: no data\"}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new data can be retrieved via this API. No data can be inserted.
\nThe request token should be provided on the request header. If the token is incorrect, the operation will not be executed.
\nThe API can prepare the data only for one user that is specified by the identifier.
\nIf the limit_per_source value is set, then only that many events are assigned from every source. For example, if the limit_per_source value is set to 1 for the purchase event, then 1 purchase event is acquired from email, web, and other sources as well.
\nIf you wish to see the quota usage for the payload then set Quota=true.
\nThe quota is limited to 1000 units per minute.
\nThe user base size and the number of types of events define the quota usage. The attribute number or set of attributes doesn't matter.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to InOne > InOne Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"segmentName\": \"My Segment Name\",\n \"fileUrl\": \"https://s3.amazonaws.com/sample_csv_file.csv\",\n \"callbackUrl\": \"https://localhost/12345\",\n \"attributeName\": \"em\"\n}"},"url":"https://contact.useinsider.com/fps/v1/upload","description":"The First-Party Segment API allows you to easily create a first-party segment through an API. When the uploading process is completed, the segment is automatically created on your First-Party Segment page under Saved Segments. In addition, you can see the results of the segment creation on the callback.
\nThe FPS segments don't generate new users; instead, they group existing users into segments based on their attribute values.
\nAssume that you want to pass your custom segment(s) via API to Insider but do not want to create a segment on Insider's InOne panel. Thanks to the FPS API, you can maintain the entire segment creation process through the API from beginning to end.
\nLet's say you want to target a set of specific user attributes that contain “Store ID” on UCD. You can basically create a .csv file and name its column as Store ID with the store ID values. To make these attribute values produce a segment, you can pass this file’s URL to the payload, and at the end of the request, you can get the number of users who have these values.
\nAssume that you have 17k store owners as your customers. Instead of multi-selecting 17k values under the segmentation filter, you can list those store_id values on a sheet and upload them to the FPS segment upload field. This way, a snapshot of the people with those store ID values is generated.
\nYou do not need to include a header row in the CSV file. The attribute name (e.g., \"Store ID\") has already been specified in the API payload. The values in the CSV file should be listed without a header.
\nEvery request made to the request endpoint requires a request body formatted in JSON containing the required body parameters.
\ncurl --location --request POST 'https://contact.useinsider.com/fps/v1/upload' \\\n--header 'X-REQUEST-TOKEN: acb123' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"segmentName\": \"My Segment Name\",\n \"fileUrl\": \"https://s3.amazonaws.com/sample_csv_file.csv\",\n \"callbackUrl\": \"https://localhost/12345\",\n \"attributeName\": \"em\"\n}'\n\nThe attribute em stands for email address in Insider's system.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"segment name already in use\"\n}\n\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Invalid Payload.\"\n}\n\n{\n \"status\": 200,\n \"segment_name\": \"My unique segment\",\n \"value_values_count\": 5,\n \"invalid_values_count\": 7,\n \"total_entered_values\": 12\n}\n\nvalid_values_count: The number of valid row values for the given attribute in the body.
\ninvalid_values_count: The number of invalid row values for the given attribute in the body. For example, you tried to map the CSV file given below with the age attribute. Since age attribute is a number, the invalid_values_count will be 2 in this case.
\ntotal_entered_values: the total number of rows in the .csv file.
\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe value of the X-PARTNER-NAME header should be lowercase.
\ncallbackUrl needs to accept POST response
\nFile size cannot be more than 50MB.
\nSegmentName can have a maximum of 40 characters.
\nInsider's UCD APIs allow you to manage your user data on Insider's Unified Customer Database (UCD). You can upsert user data, export your raw data, delete user data, update identifiers, and upload first-party segments.
\n","_postman_id":"8028ffbb-6bb3-4eb2-857a-e0288a105b6f"},{"name":"Data Governance APIs","item":[{"name":"Set data processing consent for app users","id":"dd7421c0-2e51-4ab0-847b-322a54ba9789","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_name\": \"{partnerName}\",\n \"gdpr_consent\": true,\n \"target\": {\n \"udid\": \"1A2B3C4D5E6F7X8Y9Z\"\n }\n}"},"url":"https://mobile.useinsider.com/api/v1/privacy/gdpr/consent/set","description":"EU’s General Data Protection Regulation came into force on May 25, 2018. This legislation requires Insider's customers to ask for specific consent to send their data to Insider as the Data Processor. Data Processing Consent API helps you send user consent programmatically in real-time over the web using predefined web services.
\nThe following is a sample body to pass user consent to Insider.
\n{\n \"partner_name\": \"{partner_name}\",\n \"gdpr_consent\": true,\n \"target\": {\n \"udid\": \"1A2B3C4D5E6F7X8Y9Z\"\n }\n}\n\nThe following response returns if the request is successful.
\n{\n \"status\": \"ok\"\n}\n\nThe following response returns if the partner_name or target is empty in the request.
\nBad Payload.\n\nWhen sending your request, make sure to follow these limitations.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identifiers\": {\n \"email\": \"sample@useinsider.com\"\n }\n}"},"url":"https://unification.useinsider.com/api/user/v1/delete","description":"This API enables you to delete your customer and their data when you need to.
\nFor example, one of your users might have selected GDPR’s “right-to-be-forgotten” option and you need to delete that user's data. You can call this API with the related identifier for Insider to find that user's data, and delete it.
\nEach POST body must have a unifier field under identifiers object. You can use the default identifiers such as email, phone number, or uuid and also the new custom identifier to define a unifier. For example, you use the email field as a unifier, any data without email field will not be accepted.
\nThe following is a sample JSON without a custom object.
\n{\n \"identifiers\":{\n \"email\":\"example@useinsider.com\"\n }\n}\n\nYou can also send a request with a custom object:
\n{\n \"identifiers\":{\n \"custom\":{\"custom_identifier\":\"xyz123\"}\n }\n}\n\nThe following response returns if the request is successful.
\n{}\n\nThe following response returns in case of an authentication error.
\n{\n \"success\": false,\n \"message\": \"Access Denied. You do not have sufficient access to perform this action.\"\n}\n\n{\n \"success\": false,\n \"message\": \"The request processing has failed because of an unknown error.\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly delete request can be sent via this API. No data can be retrieved.
\nThe request token should be provided on the request header. If the token is incorrect, the operation will not be executed.
\nA single HTTPS POST request can pass only 1 record (user).
\nMaximum 10,000 requests can be sent per minute.
\nThe entire request must not exceed 5 MB.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\"partner\": \"mybrand\",\n\"insider_id\": \"1122334455\",\n\"api_key\": \"1a2b3c4d5e6f\"\n}"},"url":"https://unification.useinsider.com/api/contact/v1/anonymize","description":"This API is used to delete users' PII data. Insider does not allow the deletion of the user's last remaining identifier. In addition, if this value is a PII (Personally Identifiable Information) data such as email, phone number, it would not be deleted. Thanks to this endpoint, you can delete these values associated with users; if they are a known user and their only identifier is email or phone number, then, the user becomes anonymous. For example, you can delete all PII data of registered users when they revoke their data-sharing permissions.
\nThe user attributes marked as PII are unconditionally deleted with this API.
\nNote: This action cannot be undone. Please carefully consider before proceeding.
\n{\n “insider_id”: “111ab184-f66d-4cba-123e-9abca4332211\"\n}\n\nThis response returns if the request is successful.
\nThis response returns when the request is successful.
\nThe below response returns when you send the wrong identifiers.
\n{\"error\":\"no such user for these identifiers: no data\"}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly PII data delete requests can be sent via this API. No data can be retrieved.
\nThe request token should be provided on the request header. If the token is incorrect, the operation will not be executed
\nThe rate limit is 500 requests per minute.
\nA single HTTPS POST request can pass only 1 record (users).
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identifiers\": {\n \"email\": \"sample@useinsider.com\"\n }\n}"},"url":"https://unification.useinsider.com/api/user/v1/anonymize","description":"This API is used to delete users' PII data. Insider does not allow the deletion of the user's last remaining identifier. In addition, if this value is a PII (Personally Identifiable Information) data such as email, phone number, it would not be deleted. Thanks to this endpoint, you can delete these values associated with users; if they are a known user and their only identifier is email or phone number, then, the user becomes anonymous. For example, you can delete all PII data of registered users when they revoke their data-sharing permissions.
\nThe user attributes marked as PII are unconditionally deleted with this API.
\nNote: This action cannot be undone. Please carefully consider before proceeding.
\n{\n \"identifiers\": {\n \"email\": \"sample@useinsider.com\"\n }\n}\n\nThis response returns if the request is successful.
\nThe response below returns when you send the wrong identifiers.
\n{\"error\":\"no such user for these identifiers: no data\"}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly PII data delete requests can be sent via this API. No data can be retrieved.
\nThe request token should be provided on the request header. If the token is incorrect, the operation will not be executed
\nThe rate limit is 500 requests per minute.
\nA single HTTPS POST request can pass only 1 record (users).
\nThe value of X-PARTNER-NAME header should be lowercase.
\nData Governance APIs allow you to manage the data consent of your users. You can set data processing consent for your app users, or delete existing user data.
\n","_postman_id":"46cfc19d-da1d-4eeb-ae4e-a010db48334d"},{"name":"User Subscription APIs","item":[{"name":"Email","item":[{"name":"Unsubscribe email users from database","id":"c7654f52-469f-4ad9-b047-19fe91197174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"sample@useinsider.com\"\n}"},"url":"https://contact.useinsider.com/email/v1/unsubscribe","description":"This API enables you to unsubscribe users from Insider's email platform.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata. This includes the subscriber's email address.
\nThe following is a sample body to unsubscribe a user from Email platform.
\n{\n \"email\": \"sample@mail.com\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\",\n \"sample3@useinsider.com\"\n ]\n}"},"url":"https://contact.useinsider.com/email/v2/unsubscribe","description":"The Email Unsubscribe API allows you to ingest email addresses into either the global unsubscribe list or a specific unsubscribe group you created in InOne.
\nThe Email Unsubscribe API v2 is the latest version of the Email Unsubscribe API, which supports bulk data ingestion. If you're still using the previous version (v1), we strongly recommend migrating to this updated version to benefit from bulk updates and enhanced functionality. Please note that new integrations with v1 are no longer supported.
\nAPI usage changes depending on the identifier format you're using. Please refer to the relevant section based on your identifier configuration.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
\nIn cases where the email is used as the identifier, if the user exists, their status will be updated; if the user does not exist, a new user will be created.
For the email-based flow, the same request is used; however, it will only update the status of existing users and will not create new users.
The emails field is required for global unsubscribe requests.
\ncurl --location 'contact.useinsider.com/email/v2/unsubscribe' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\",\n \"sample3@useinsider.com\"\n ]\n}'\n\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
\nIf the profile-based flow is enabled for your account,
- If the user in the request exists, their status will be updated.
- If the user does not exist, a new user will be created.
The uuid and email fields are required for global unsubscribe requests.
\ncurl --location 'http://contact.useinsider.com/email/v2/unsubscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'x-request-token: a1b2c3d4e5f6' \\\n--header 'x-partner-name: mybrand' \\\n--data-raw '{\n \"users\": [\n {\n \"uuid\": \"test-uuid-1\",\n \"email\": \"sample1@useinsider.com\"\n },\n {\n \"uuid\": \"test-uuid-2\",\n \"email\": \"sample2@useinsider.com\"\n },\n {\n \"uuid\": \"test-uuid-3\",\n \"email\": \"sample3@useinsider.com\"\n },\n {\n \"uuid\": \"test-uuid-4\",\n \"email\": \"sample4@useinsider.com\"\n }\n ]\n}'\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nA maximum of 500 emails or UUIDs can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\",\n \"sample3@useinsider.com\"\n ]\n}"},"url":"https://contact.useinsider.com/email/v2/unsubscribe","description":"The Email Unsubscribe API allows you to ingest email addresses into either the global unsubscribe list or a specific unsubscribe group you created in InOne.
\nThe Email Unsubscribe API v2 is the latest version of the Email Unsubscribe API, which supports bulk data ingestion. If you're still using the previous version (v1), we strongly recommend migrating to this updated version to benefit from bulk updates and enhanced functionality. Please note that new integrations with v1 are no longer supported.
\nAPI usage changes depending on the identifier format you're using. Please refer to the relevant section based on your identifier configuration.
\nIn cases where the email is used as the identifier, if the user exists, their status will be updated; if the user does not exist, a new user will be created.
\nFor the email-based flow, the same request is used; however, it will only update the status of existing users and will not create new users.
\nThe emails and group_name fields are required for the group unsubscribe requests. If the group name you provided does not already exist, a new group will be created with that name when the request is sent.
\ncurl --location 'contact.useinsider.com/email/v2/unsubscribe' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\",\n \"sample3@useinsider.com\",\n \"sample4@useinsider.com\",\n \"sample5@useinsider.com\"\n ],\n \"group_name\": \"unsubscribe_group_name\"\n}'\n\nThe email, uuid, and group_name fields are required for the group unsubscribe requests.
\nIf the group name you provided does not already exist, a new group will be created with that name when the request is sent.
\ncurl --location 'http://contact.useinsider.com/email/v2/unsubscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'x-request-token: a1b2c3d4e5f6' \\\n--header 'x-partner-name: mybrand' \\\n--data-raw '{\n \"users\": [\n {\n \"uuid\": \"test-uuid-1\",\n \"email\": \"sample1@useinsider.com\"\n },\n {\n \"uuid\": \"test-uuid-2\",\n \"email\": \"sample2@useinsider.com\"\n },\n {\n \"uuid\": \"test-uuid-3\",\n \"email\": \"sample3@useinsider.com\"\n },\n {\n \"uuid\": \"test-uuid-4\",\n \"email\": \"sample4@useinsider.com\"\n }\n ]\n \"group_name\": \"group_name\"\n}'\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nA maximum of 500 emails or UUIDs can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"sample@useinsider.com\"\n}"},"url":"https://contact.useinsider.com/email/v1/subscribe","description":"This API allows you to set an unreachable email status as reachable on Insider's email platform.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata. This includes the subscriber's email address.
\nThe following is a sample body to resubscribe a user to the Email platform.
\n{\n \"email\": \"sample@mail.com\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nThis is your partner name. Navigate to InOne > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Resubscribe token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://contact.useinsider.com/email/v2/subscribe","description":"The Email Resubscribe API allows you to set an unreachable email status as reachable on the Insider's Email platform.
\nThe Resubscribe API v2 is the latest version of the Email Resubscribe API, which supports bulk data ingestion. If you're still using the previous version (v1), we strongly recommend migrating to this updated version to benefit from bulk updates and enhanced functionality. Please note that new integrations with v1 are no longer supported.
\nAPI usage changes depending on the identifier format you're using. Please refer to the relevant section based on your identifier configuration.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
\nFor the email-based flow, the same request is used; however, it will only update the status of existing users and will not create new users.
\nThe emails field is required for resubscribe requests.
\ncurl --location --request POST 'http://contact.useinsider.com/email/v2/subscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--data-raw '{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\"\n ]\n}'\n\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
\nIf the profile-based flow is enabled for your account:
- If the user in the request exists, their status will be updated.
- If the user does not exist, a new user will be created.
The uuid, and uploader_email fields are required for resubscribe requests.
\ncurl --location 'https://contact.useinsider.com/email/v2/subscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'x-request-token: mybrand' \\\n--header 'x-partner-name: a1b2c3d4e5f6' \\\n--data-raw '{\n \"uuids\": [\n \"test-uuid-1\",\n \"test-uuid-2\",\n \"test-uuid-3\",\n \"test-uuid-7\"\n ],\n \"emails\": [\n \"samlpe1@useinsider.com\",\n \"sample2@useinsider.com\",\n \"sample3@useinsider.com\",\n \"sample4@useinsider.com\"\n ]\n}'\n\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nA maximum of 500 emails or UUIDs can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\n\n\n","urlObject":{"protocol":"https","path":["email","v2","subscribe"],"host":["contact","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2ba4d4b-facd-4435-a718-1a383b7abda9"},{"name":"Resubscribe Email Users for Email Group Subscribe","id":"cff18d71-7f92-42e0-b57f-6b8c2ba41aba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"<p >The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider team — we can adjust it to fit your needs.</p>
\n
This is your partner name. Navigate to InOne > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Resubscribe token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\"\n ],\n \"group_id\": 12345\n}","options":{"raw":{"language":"json"}}},"url":"https://contact.useinsider.com/email/v2/subscribe","description":"The Email Resubscribe API allows you to set an unreachable email status as reachable on the Insider's Email platform.
\nThe Resubscribe API v2 is the latest version of the Email Resubscribe API, which supports bulk data ingestion. If you're still using the previous version (v1), we strongly recommend migrating to this updated version to benefit from bulk updates and enhanced functionality. Please note that new integrations with v1 are no longer supported.
\nAPI usage changes depending on the identifier format you're using. Please refer to the relevant section based on your identifier configuration.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
\nThe emails and group_id are required for the group resubscribe requests.
\nWith this request, you can only subscribe users from an existing group; a new group cannot be created.
\ncurl --location --request POST 'http://contact.useinsider.com/email/v2/subscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--data-raw '{\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\"\n ],\n \"group_id\": 12345\n}'\n\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
\nThe emails, uuids and group_id fields are required for the group resubscribe requests.
\nWith this request, you can only subscribe users from an existing group; a new group cannot be created.
\ncurl --location 'https://contact.useinsider.com/email/v2/subscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'x-request-token: mybrand' \\\n--header 'x-partner-name: a1b2c3d4e5f6' \\\n--data-raw '{\n \"uuids\": [\n \"test-uuid-1\",\n \"test-uuid-2\",\n \"test-uuid-3\",\n \"test-uuid-7\"\n ],\n \"emails\": [\n \"sample1@useinsider.com\",\n \"sample2@useinsider.com\",\n \"sample3@useinsider.com\",\n \"sample4@useinsider.com\"\n ],\n \"group_id\": 12345\n}'\n\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nA maximum of 500 emails or UUIDs can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\n\n\n","urlObject":{"protocol":"https","path":["email","v2","subscribe"],"host":["contact","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cff18d71-7f92-42e0-b57f-6b8c2ba41aba"}],"id":"7bbc4a85-03cf-4edb-93d4-c456383d9b20","description":"The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider team — we can adjust it to fit your needs.
\n
With these APIs, you can manage the email subscription preferences of your users. You can unsubscribe them from Insider's database, or resubscribe them for your email campaigns.
\n","_postman_id":"7bbc4a85-03cf-4edb-93d4-c456383d9b20"},{"name":"WhatsApp","item":[{"name":"Unsubscribe WhatsApp users from database","id":"65d12e01-18fc-40d6-85aa-638b95eaaa9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+6512345678\"\n}"},"url":"https://contact.useinsider.com/whatsapp/v1/unsubscribe","description":"This API enables you to unsubscribe users from Insider's WhatsApp platform.
\nA newer version of the Unsubscribe API is available with support for bulk data ingestion. While the older version is still supported, we recommend using the latest version for improved functionality and future compatibility.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your phone number’s content and metadata. This includes the subscriber’s phone number.
\nThe following is a sample body to unsubscribe users from WhatsApp platform.
\n{\n \"phone_number\": \"+905012345678\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly global unsubscribers can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}"},"url":"https://contact.useinsider.com/whatsapp/v2/unsubscribe","description":"The WhatsApp Unsubscribe API enables you to unsubscribe users from Insider's WhatsApp platform.
\nIf a user exists with the provided phone number, the user's subscription status will be updated. If no user exists and the phone number is used as an identifier, a new user will be created.
\nEvery request made to the request endpoint requires a request body formatted in JSON containing your phone number’s content and metadata, including the subscriber’s phone number.
\nThe phone_numbers field is required for resubscribe requests.
\ncurl --location --request POST 'http://contact.useinsider.com/whatsapp/v2/unsubscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--data-raw '{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}'\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly phone numbers can be sent via this API. No data can be retrieved.
\nA maximum of 500 phone numbers can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of the X-PARTNER-NAME header should be lowercase.
\nThe default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider team — we can adjust it to fit your needs.
\n","urlObject":{"protocol":"https","path":["whatsapp","v2","unsubscribe"],"host":["contact","useinsider","com"],"query":[],"variable":[]}},"response":[{"id":"7e599235-fd0e-457c-9448-1094193ff449","name":"Unsubscribe WhatsApp users","originalRequest":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+16102347589\"\n}","options":{"raw":{"language":"json"}}},"url":"https://contact.useinsider.com/whatsapp/v1/unsubscribe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 May 2023 13:01:34 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"22","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-envoy-upstream-service-time","value":"121","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Set-Cookie","value":"__cf_bm=aUwYKAPcIwZw286m8tiW.4k1pjTJSuuLMgK59gQ50h4-1685106094-0-AVDM49tTahTIQk2XXCuqqxua00pqcdCop4LZuQfQNvPKKkV8SZrk/JJOKrX1nyWtWUlj4x+JLev5nhONiwbTXvo=; path=/; expires=Fri, 26-May-23 13:31:34 GMT; domain=.useinsider.com; HttpOnly; Secure; SameSite=None","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cd635217aef3b4d-IAD","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"statusMessage\": \"OK\"\n}"}],"_postman_id":"3b339f0f-cb5f-48b9-aa11-f8bfa92c7269"},{"name":"Resubscribe WhatsApp users","id":"b76eb310-0d86-4535-b24f-a29bd384102c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+655012345678\"\n}"},"url":"https://contact.useinsider.com/whatsapp/v1/subscribe","description":"This API allows you to set an unreachable phone number status as reachable on Insider's WhatsApp platform.
\nA newer version of the Resubscribe API is available with support for bulk data ingestion. While the older version is still supported, we recommend using the latest version for improved functionality and future compatibility.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your phone number’s content and metadata. This includes the subscriber’s phone number.
\nThe following is a sample body to resubsribe users to Insider's WhatsApp platform.
\n{\n \"phone_number\": \"+905012345678\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly phone numbers can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}"},"url":"https://contact.useinsider.com/whatsapp/v2/subscribe","description":"The WhatsApp Resubscribe API enables you to update an unreachable phone number status to reachable on Insider's WhatsApp platform.
\nIf a user exists with the provided phone number, the user's subscription status will be updated. If no user exists and the phone number is used as an identifier, a new user will be created.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your phone number’s content and metadata. This includes the subscriber’s phone number.
\nEvery request made to the request endpoint requires a request body formatted in JSON containing your phone number’s content and metadata, including the subscriber’s phone number.
\nThe phone_numbers field is required for resubscribe requests.
\ncurl --location --request POST 'http://contact.useinsider.com/whatsapp/v2/subscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--data-raw '{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}'\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly phone numbers can be sent via this API. No data can be retrieved.
\nA maximum of 500 phone numbers can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of the X-PARTNER-NAME header should be lowercase.
\nThe default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider team — we can adjust it to fit your needs.
\n","urlObject":{"protocol":"https","path":["whatsapp","v2","subscribe"],"host":["contact","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e9ff6e7-8dbd-40c1-b167-4a23d013eef0"}],"id":"f269615b-4eaf-45d7-8802-6b3656276e6c","description":"With these APIs, you can manage the WhatsApp subscription preferences of your users. You can unsubscribe them from Insider's database, or resubscribe them for your WhatsApp campaigns.
\n","_postman_id":"f269615b-4eaf-45d7-8802-6b3656276e6c"},{"name":"SMS","item":[{"name":"Unsubscribe SMS users from database","id":"a9ebbbf0-2049-4f44-b5d0-b94e849c996c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+65012345678\"\n}"},"url":"https://contact.useinsider.com/sms/v1/unsubscribe","description":"This API enables you to unsubscribe users from Insider's SMS platform.
\nA newer version of the Unsubscribe API is available with support for bulk data ingestion. While the older version is still supported, we recommend using the latest version for improved functionality and future compatibility.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your phone number’s content and metadata. This includes the subscriber’s phone number.
\nThe following is a sample body to unsubscribe users from the SMS platform.
\n{\n \"phone_number\": \"+905012345678\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly global unsubscribers can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}"},"url":"https://contact.useinsider.com/sms/v2/unsubscribe","description":"The SMS Unsubscribe API enables you to unsubscribe users from Insider's SMS platform.
\nIf a user exists with the provided phone number, the user's subscription status will be updated. If no user exists and the phone number is used as an identifier, a new user will be created.
\nEvery request made to the request endpoint requires a request body formatted in JSON containing your phone number’s content and metadata, including the subscriber’s phone number.
\nThe phone_numbers field is required for resubscribe requests.
\ncurl --location --request POST 'http://contact.useinsider.com/sms/v2/unsubscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--data-raw '{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}'\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly phone numbers can be sent via this API. No data can be retrieved.
\nA maximum of 500 phone numbers can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of the X-PARTNER-NAME header should be lowercase.
\nThe default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider team — we can adjust it to fit your needs.
\n","urlObject":{"protocol":"https","path":["sms","v2","unsubscribe"],"host":["contact","useinsider","com"],"query":[],"variable":[]}},"response":[{"id":"a5684ba1-9d97-4e48-a454-f79444452fce","name":"Unsubscribe SMS users","originalRequest":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+16102347589\"\n}","options":{"raw":{"language":"json"}}},"url":"https://contact.useinsider.com/sms/v1/unsubscribe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 May 2023 13:04:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"22","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-envoy-upstream-service-time","value":"116","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cd639519fff57e5-IAD","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"statusMessage\": \"OK\"\n}"}],"_postman_id":"c0b1c5b2-0d55-429a-be6d-ca4f969e17df"},{"name":"Resubscribe SMS users","id":"f7886410-7880-43e5-bdf4-3ba6e95b5931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+655012345678\"\n}"},"url":"https://contact.useinsider.com/sms/v1/subscribe","description":"This API allows you to set an unreachable phone number status as reachable on Insider's SMS platform.
\nA newer version of the Resubscribe API is available with support for bulk data ingestion. While the older version is still supported, we recommend using the latest version for improved functionality and future compatibility.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your phone number’s content and metadata. This includes the subscriber’s phone number.
\nThe following is a sample body to resubscribe users to the SMS platform.
\n{\n \"phone_number\": \"+905012345678\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly phone numbers can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}"},"url":"https://contact.useinsider.com/sms/v2/subscribe","description":"The SMS Resubscribe API enables you to update an unreachable phone number status to reachable on Insider's SMS platform.
\nIf a user exists with the provided phone number, the user's subscription status will be updated. If no user exists and the phone number is used as an identifier, a new user will be created.
\nEvery request made to the request endpoint requires a request body formatted in JSON containing your phone number’s content and metadata, including the subscriber’s phone number.
\nThe phone_numbers field is required for resubscribe requests.
\ncurl --location --request POST 'http://contact.useinsider.com/sms/v2/subscribe' \\\n--header 'Content-Type: application/json' \\\n--header 'X-PARTNER-NAME: mybrand' \\\n--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \\\n--data-raw '{\n \"phone_numbers\": [\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\",\n \"+900000000000\"\n ]\n}'\n\nThe following response returns if the request is successful.
\n{\n \"statusMessage\": \"OK\"\n}\n\n{\n \"statusMessage\": \"Bad request\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"statusMessage\": \"Unauthorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly phone numbers can be sent via this API. No data can be retrieved.
\nA maximum of 500 phone numbers can be consumed in one request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
\nThe value of the X-PARTNER-NAME header should be lowercase.
\nThe default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider team — we can adjust it to fit your needs.
\n","urlObject":{"protocol":"https","path":["sms","v2","subscribe"],"host":["contact","useinsider","com"],"query":[],"variable":[]}},"response":[{"id":"80057ee6-65a4-4f9b-95e7-6757bce84c7d","name":"Resubscribe SMS users","originalRequest":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"","description":"This is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase.","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. ","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"+16102347589\"\n}","options":{"raw":{"language":"json"}}},"url":"https://contact.useinsider.com/sms/v1/subscribe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 May 2023 13:05:39 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"22","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-envoy-upstream-service-time","value":"191","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cd63b194dd67fbe-IAD","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"statusMessage\": \"OK\"\n}"}],"_postman_id":"8ddba16f-e453-4b41-94b0-05c20234d170"}],"id":"1097adcb-edb6-4955-977b-ad8fca657550","description":"With these APIs, you can manage the SMS subscription preferences of your users. You can unsubscribe them from Insider's database, or resubscribe them for your SMS campaigns.
\n","_postman_id":"1097adcb-edb6-4955-977b-ad8fca657550"}],"id":"7767f0c6-f266-4937-86ff-1893c463956d","description":"User Subscription APIs allow you to manage the subscription preferences of your users for Email, WhatsApp, and SMS platforms. You can unsubscribe and resubscribe your users via these APIs.
\n","_postman_id":"7767f0c6-f266-4937-86ff-1893c463956d"},{"name":"Messaging APIs","item":[{"name":"Email APIs","item":[{"name":"Send transactional emails","id":"f6c3aac0-5b17-48c1-b510-546d552f6ea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"},{"key":"Cache-Control","value":"no-cache","description":"This header specifies browser caching in requests and responses.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subject\": \"Hello\",\n \"tos\": [\n {\n \"name\": \"John Doe\",\n \"email\": \"sample@useinsider.com\"\n }\n ],\n \"from\": {\n \"name\": \"Posh Street\",\n \"email\": \"posh@useinsider.com\"\n },\n \"content\": [\n {\n \"type\": \"text/html\",\n \"value\": \"I am {{first_name}}.
\"\n }\n ],\n \"cc\": [\n {\n \"name\": \"User in CC\",\n \"email\": \"user.cc@useinsider.com\"\n }\n ],\n \"bcc\": [\n {\n \"name\": \"User in BCC\",\n \"email\": \"user.bcc@useinsider.com\"\n }\n ],\n \"reply_to\": {\n \"name\": \"Reply to\",\n \"email\": \"reply@useinsider.com\"\n },\n \"dynamic_fields\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"product_name1\": \"Laptop\",\n \"price1\": \"$1000\",\n \"product_name2\": \"Iphone\",\n \"price2\": \"$850\"\n },\n \"unique_args\": {\n \"category\": \"Confirmation Email\",\n \"purchase_channel\": \"App\"\n },\n \"attachments\": [\n {\n \"content\": \"aW5zaWRlciB0ZXN0\",\n \"file_name\": \"file.txt\"\n }\n ],\n \"callback\": {\n \"url\": \"yourcallbackurl\",\n \"secret\": \"yoursecret\"\n }\n}"},"url":"https://mail.useinsider.com/mail/v1/send","description":"This API enables you to send targeted ecommerce and personalized one to one emails to your users. You can trigger these emails once a user takes a specific action on your platform.
\nYou can use transactional emails to:
\nSend a post-purchase email to share details about a purchase/booking,
\nHelp your users reset their password if they forget it,
\nConfirm an order a user places,
\nShare delivery tracking details of a purchase (when it is shipped, on the way, and delivered) and to take many other actions.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata (e.g. to, reply-to, and email subject).
\nThe following is a sample body to send transactional emails.
\n{\n \"subject\": \"Hello\",\n \"tos\": [\n {\n \"name\": \"John Doe\",\n \"email\": \"sample@mail.com\"\n }\n ],\n \"from\": {\n \"name\": \"Posh Street\",\n \"email\": \"posh@street.com\"\n },\n \"content\": [\n {\n \"type\": \"text/html\",\n \"value\": \"<p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>I am {{first_name}}.</p>\"\n }\n ],\n \"cc\": [\n {\n \"name\": \"User in CC\",\n \"email\": \"user.cc@mail.com\"\n }\n ],\n \"bcc\": [\n {\n \"name\": \"User in BCC\",\n \"email\": \"user.bcc@mail.com\"\n }\n ],\n \"reply_to\": {\n \"name\": \"Reply to\",\n \"email\": \"reply@mail.com\"\n },\n \"dynamic_fields\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"product_name1\": \"Laptop\",\n \"price1\": \"$1000\",\n \"product_name2\": \"Iphone\",\n \"price2\": \"$850\"\n },\n \"unique_args\": {\n \"category\": \"Confirmation Email\",\n \"purchase_channel\": \"App\"\n },\n \"attachments\": [\n {\n \"content\": \"aW5zaWRlciB0ZXN0\",\n \"file_name\": \"file.txt\"\n }\n ],\n \"callback\": {\n \"url\": \"yourcallbackurl\",\n \"secret\": \"yoursecret\"\n }\n}\n\nIf you create your transactional email template via the Email Template Library, use the following sample payload instead. In this example, the ID of the template is used by the template_id key.
{\n \"subject\": \"Hello\",\n \"tos\": [\n {\n \"name\": \"John Doe\",\n \"email\": \"sample@useinsider.com\"\n }\n ],\n \"from\": {\n \"name\": \"Posh Street\",\n \"email\": \"posh@street.com\"\n },\n \"reply_to\": {\n \"name\": \"Reply to\",\n \"email\": \"reply@useinsider.com\"\n },\n \"template_id\": \"275\",\n \"content\": [\n {\n \"type\": \"text/html\",\n \"value\": \"html code\"\n }\n ],\n \"attachments\": [],\n \"dynamic_fields\": {}\n}\n\nThis response indicates that your request was successfully completed.
\n{\n \"message_id\": \"8e664ecd-352d-4dbd-9786-ceb78b5b173b\",\n \"status_message\": \"accepted\"\n}\n\nThis response indicates that your request is missing the email address in the 'to' parameter.
\n{\n \"errors\": [\n \"Missing 'email' on 'tos' parameter\"\n ],\n \"status_message\": \"failed to validate request\"\n}\n\nThis response indicates that the request has an invalid callback URL.
\n{\n \"errors\": [\n \"Invalid callback URL in 'url' on 'callback'\"\n ],\n \"status_message\": \"failed to validate request\"\n}\n\nThis response indicates that the content type header of the request is incorrect.
\n{\n \"message\": \"content type must be application/json\",\n \"status\": 400\n}\n\nThis response indicates that the request is missing the 'subject' parameter.
\n{\n \"errors\": [\n \"Missing 'subject' parameter\"\n ],\n \"message\": \"bad-request\",\n \"status\": 400\n}\n\nThis response indicates that the request is missing the 'content' parameter.
\n{\n \"errors\": [\n \"Missing 'content' parameter\"\n ],\n \"message\": \"bad-request\",\n \"status\": 400\n}\n\nThis response indicates that the request is missing the 'from' parameter.
\n{\n \"errors\": [\n \"Missing 'from' parameter\"\n ],\n \"message\": \"bad-request\",\n \"status\": 400\n}\n\nThis response indicates that the request is missing the 'to' parameter.
\n{\n \"errors\": [\n \"Missing 'to' parameter\"\n ],\n \"message\": \"bad-request\",\n \"status\": 400\n}\n\nThis response indicates that the API key provided in the request is invalid, expired, or revoked.
\n{\n \"message\": \"The provided API key is invalid, expired or revoked\",\n \"status\": 401\n}\n\nThis response indicates that an internal error occurred on the server side and the request could not be processed.
\nThis response indicates that the service is temporarily unavailable due to server overload or maintenance.
\nThis response indicates that the server did not receive a timely response from an upstream server.
\nThis response indicates an unexpected error on the Cloudflare network side, preventing the request from being processed.
\nSuggested Retry Mechanism: If any of the above errors are encountered, the request was not processed successfully on the server side. A retry mechanism is recommended to distribute retries randomly within a 5-minute interval, allowing server resources to recover and traffic to stabilize.
\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new emails can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nTransactional API cannot be used for sending bulk emails. It is designed only to set transactional emails.
\nThe rate limit is 2000 requests per second.
\nHello {{first_name}}! Thank you for purchasing {{product_name1}} and {{product_name2}}.
\"\n }\n ],\n \"dynamic_fields\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"product_name1\": \"Yoga Leggings\",\n \"price1\": \"$35\",\n \"product_name2\": \"Sports Bra\",\n \"price2\": \"$12\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://mail.useinsider.com/mail/v1/send"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 May 2023 12:46:33 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-envoy-upstream-service-time","value":"110","enabled":true},{"key":"vary","value":"Accept-Encoding","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Set-Cookie","value":"__cf_bm=P8Y4dNl56X4Ui2qNuETXTwz1f3WEnuAmFecF.9uJQbo-1685105193-0-AShO6RMFSS8Mo5KyNk9tERCAnIyLu/CWPCpcRV1xEBniWDqEOmkeaikABVaWyKXmvfP59PZQWjoYpIWGmg+jZ9E=; path=/; expires=Fri, 26-May-23 13:16:33 GMT; domain=.useinsider.com; HttpOnly; Secure; SameSite=None","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cd61f1f29657fca-IAD","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message_id\": \"f0935bbf-fe1d-4b89-aa04-149c9a860081\",\n \"status_message\": \"accepted\"\n}"}],"_postman_id":"f6c3aac0-5b17-48c1-b510-546d552f6ea0"},{"name":"Create email campaigns","id":"bb5da9a3-0d88-4ffd-94d3-97a3f25fc84c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"my single campaign\",\n \"tags\": [\n \"v\",\n \"tag1 789dfs44\"\n ],\n \"type\": \"single\",\n \"variations\": [\n {\n \"subject\": \"Hello {{name}} {{email}} {{custom3|fallback}}\",\n \"pre_header\": \"apre {{surname|there}}\",\n \"html\": \"PHRkIGNsYXNzPSJlc2Qtc3RydWN0dXJlIGVzLXAyMCIgYWxpZ249ImxlZnQiIGJnY29sb3I9IiM5MTk0OUYiIHN0eWxlPSJiYWNrZ3JvdW5kLWNvbG9yOiAjOTE5NDlGOyI+DQogICAgPHRhYmxlIHdpZHRoPSIxMDAlIiBjZWxsc3BhY2luZz0iMCIgY2VsbHBhZGRpbmc9IjAiPg0KICAgICAgICA8dGJvZHk+DQogICAgICAgICAgICA8dHI+DQogICAgICAgICAgICAgICAgPHRkIGNsYXNzPSJlc2QtY29udGFpbmVyLWZyYW1lIiB3aWR0aD0iNTYwIiB2YWxpZ249InRvcCIgYWxpZ249ImNlbnRlciI+DQogICAgICAgICAgICAgICAgICAgIDx0YWJsZSB3aWR0aD0iMTAwJSIgY2VsbHNwYWNpbmc9IjAiIGNlbGxwYWRkaW5nPSIwIj4NCiAgICAgICAgICAgICAgICAgICAgICAgIDx0Ym9keT4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8dHI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0iY2VudGVyIiBjbGFzcz0iZXNkLWJsb2NrLWltYWdlIGVzLXAxNSIgc3R5bGU9ImZvbnQtc2l6ZTogMHB4OyI+PGEgdGFyZ2V0PSJfYmxhbmsiPjxpbWcgY2xhc3M9ImFkYXB0LWltZyIgc3JjPSJodHRwczovL2ltYWdlLnVzZWluc2lkZXIuY29tL2VtYWlsLXRlbXBsYXRlL2xvZ28ucG5nIiBhbHQgc3R5bGU9ImRpc3BsYXk6IGJsb2NrOyIgaGVpZ2h0PSIzMCI+PC9hPjwvdGQ+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgPC90cj4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8dHI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDx0ZCBjbGFzcz0iZXNkLWJsb2NrLXRleHQiIGFsaWduPSJjZW50ZXIiPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgPGgyIHN0eWxlPSJjb2xvcjogI0ZGRkZGRjsgZm9udC1zaXplOiAzMHB4OyI+PHN0cm9uZz5UaW1lIGZvciBncmVhdCBlbWFpbCBkZXNpZ248L3N0cm9uZz48L2gyPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8L3RkPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgIDwvdHI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgPHRyPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8dGQgY2xhc3M9ImVzZC1ibG9jay10ZXh0IGVzLW0tdHh0LWMgZXMtcDEwdCIgYWxpZ249ImNlbnRlciI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8cCBzdHlsZT0iY29sb3I6ICNGRkZGRkY7Ij5UaGlzIGlzIGEgbmV3IHRleHQgYmxvY2sgcmVhZHkgZm9yIHlvdXIgbWVzc2FnZSBjb250ZW50LjwvcD4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgPC90ZD4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8L3RyPg0KICAgICAgICAgICAgICAgICAgICAgICAgPC90Ym9keT4NCiAgICAgICAgICAgICAgICAgICAgPC90YWJsZT4NCiAgICAgICAgICAgICAgICA8L3RkPg0KICAgICAgICAgICAgPC90cj4NCiAgICAgICAgPC90Ym9keT4NCiAgICA8L3RhYmxlPg0KPC90ZD4=\",\n \"utm\": {\n \"source\": \"thisis_source\",\n \"campaign\": \"thisis_campaign\",\n \"medium\": \"thisis_medium\",\n \"extra\": \"thisis_extra\"\n }\n }\n ]\n}"},"url":"https://mail.useinsider.com/content/v1/campaign/create","description":"This API enables you to send email body and subject from your back-end to create email campaigns on Insider platform. With this API request, you can specify the account name, campaign name and campaign type.
\nYou can use this API to:
\nBefore sending your request, make sure you create it within the following criteria:
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your email's content as variations.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\nBelow is a sample body for a Single email campaign.
\n{\n \"name\": \"my single campaign\",\n \"tags\": [\n \"v\",\n \"tag1 789dfs44\"\n ],\n \"type\": \"single\",\n \"variations\": [\n {\n \"subject\": \"Hello {{name}} {{email}} {{custom3|fallback}}\",\n \"pre_header\": \"apre {{surname|there}}\",\n \"html\": \"PHRkIGNsYXNzPSJlc2Qtc3RydWN0dXJlIGVzLXAyMCIgYWxpZ249ImxlZnQiIGJnY29sb3I9IiM5MTk0OUYiIHN0eWxlPSJiYWNrZ3JvdW5kLWNvbG9yOiAjOTE5NDlGOyI+DQogICAgPHRhYmxlIHdpZHRoPSIxMDAlIiBjZWxsc3BhY2luZz0iMCIgY2VsbHBhZGRpbmc9IjAiPg0KICAgICAgICA8dGJvZHk+DQogICAgICAgICAgICA8dHI+DQogICAgICAgICAgICAgICAgPHRkIGNsYXNzPSJlc2QtY29udGFpbmVyLWZyYW1lIiB3aWR0aD0iNTYwIiB2YWxpZ249InRvcCIgYWxpZ249ImNlbnRlciI+DQogICAgICAgICAgICAgICAgICAgIDx0YWJsZSB3aWR0aD0iMTAwJSIgY2VsbHNwYWNpbmc9IjAiIGNlbGxwYWRkaW5nPSIwIj4NCiAgICAgICAgICAgICAgICAgICAgICAgIDx0Ym9keT4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8dHI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0iY2VudGVyIiBjbGFzcz0iZXNkLWJsb2NrLWltYWdlIGVzLXAxNSIgc3R5bGU9ImZvbnQtc2l6ZTogMHB4OyI+PGEgdGFyZ2V0PSJfYmxhbmsiPjxpbWcgY2xhc3M9ImFkYXB0LWltZyIgc3JjPSJodHRwczovL2ltYWdlLnVzZWluc2lkZXIuY29tL2VtYWlsLXRlbXBsYXRlL2xvZ28ucG5nIiBhbHQgc3R5bGU9ImRpc3BsYXk6IGJsb2NrOyIgaGVpZ2h0PSIzMCI+PC9hPjwvdGQ+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgPC90cj4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8dHI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDx0ZCBjbGFzcz0iZXNkLWJsb2NrLXRleHQiIGFsaWduPSJjZW50ZXIiPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgPGgyIHN0eWxlPSJjb2xvcjogI0ZGRkZGRjsgZm9udC1zaXplOiAzMHB4OyI+PHN0cm9uZz5UaW1lIGZvciBncmVhdCBlbWFpbCBkZXNpZ248L3N0cm9uZz48L2gyPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8L3RkPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgIDwvdHI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgPHRyPg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8dGQgY2xhc3M9ImVzZC1ibG9jay10ZXh0IGVzLW0tdHh0LWMgZXMtcDEwdCIgYWxpZ249ImNlbnRlciI+DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8cCBzdHlsZT0iY29sb3I6ICNGRkZGRkY7Ij5UaGlzIGlzIGEgbmV3IHRleHQgYmxvY2sgcmVhZHkgZm9yIHlvdXIgbWVzc2FnZSBjb250ZW50LjwvcD4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgPC90ZD4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8L3RyPg0KICAgICAgICAgICAgICAgICAgICAgICAgPC90Ym9keT4NCiAgICAgICAgICAgICAgICAgICAgPC90YWJsZT4NCiAgICAgICAgICAgICAgICA8L3RkPg0KICAgICAgICAgICAgPC90cj4NCiAgICAgICAgPC90Ym9keT4NCiAgICA8L3RhYmxlPg0KPC90ZD4=\",\n \"utm\": {\n \"source\": \"thisis_source\",\n \"campaign\": \"thisis_campaign\",\n \"medium\": \"thisis_medium\",\n \"extra\": \"thisis_extra\"\n }\n }\n ]\n}\n\nBelow is a sample body for an Experiment (A/B) campaign.
\n{\n \"name\": \"Campaign Name\",\n \"tags\": [\n \"campaign-tag\"\n ],\n \"type\": \"experiment\",\n \"variations\": [\n {\n \"subject\": \"Variation A subject {{custom}}\",\n \"html\": \"PHA+TXkgZW1haWwgYm9keSBBPC9wPg==\",\n \"pre_header\": \"Variation A preheader\"\n },\n {\n \"subject\": \"Variation B subject {{custom}}\",\n \"html\": \"PHA+TXkgZW1haWwgYm9keSBBPC9wPg==\",\n \"pre_header\": \"Variation B preheader\",\n \"utm\": {\n \"source\": \"my_source\",\n \"campaign\": \"my_campaign\",\n \"medium\": \"email\",\n \"extra\": \"value\"\n }\n }\n ]\n}\n\nThe following response returns if the request is successful.
\n{\n \"message\":\"created\",\n \"id\":\"builderID\"\n}\n\nThe following response returns if the request is not validated.
\n{\n \"error\":\"$message\"\n}\n\nThe following response returns if the request is not authorized.
\n{\n \"error\":\"unathorized\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nWith these APIs, you can create single or experiment (A/B) email campaigns from your back-end, and trigger transacational emails based on a specific user action.
\n","_postman_id":"c309c175-51ba-45f9-b73c-2ce2a6167cf5"},{"name":"Web Push APIs","item":[{"name":"Create single web pushes","id":"5a479f5c-aa1e-4439-b42c-e775cb7f35a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer","description":"This key is required to authorize your request. Navigate to Web Push > Settings > Integration Settings to get your API token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"100XXXXX\",\n \"title\": \"Title of campaign\",\n \"language\": \"tr_TR\",\n \"is_all\": false\n}"},"url":"https://web-push.api.useinsider.com/v1/single","description":"Insider's web push API allows you to send single web push notifications from your own back-end without using Insider's InOne panel.
\nEach request body requires a partner ID and a title.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo add your partner ID in partner_id.
\nTo add your campaign name in title.
\nWhen you send the request, you will get your campaign_id as a response. You will use this campaign_id when launching the campaign.
\ncurl --location --request POST 'https://web-push.api.useinsider.com/v1/single' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data-raw '{\n \"partner_id\": \"100XXXXX\",\n \"title\": \"Title of campaign\",\n \"language\": \"tr_TR\",\n \"is_all\": false\n}'\n\nYou can see this kind of response when you successfully created your campaign.
\n{\n \"success\": true,\n \"campaign_id\": 25696\n}\n\nYou can also see your campaign in your InOne panel on the Web Push listing page as in Draft status, indicating that the campaign has been created but not launched yet.
\n{\n\"message\": \"Unauthorized\"\n}\n\n{\n \"message\": \"SERVICE:-\"\n}\n\n400: Bad request
\n401: Unauthorized request
\n424 Failed Dependency
\n429 Request limit exceeded
\nAll create requests must be executed with an HTTPS POST request.
\nThe API key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 30 requests per minute second.
\nThis key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"100000001\",\n \"title\": \"title of push\",\n \"description\": \"description of push\",\n \"image\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"banner\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"link\": \"https://image.useinsider.com\",\n \"include_unengage\": true,\n \"ttl\": \"1000\"\n}"},"url":"https://web-push.api.useinsider.com/v1/single/campaign_id","description":"Insider's web push API allows you to launch single web push notifications from your own back-end without using Insider's InOne panel.
\nEach request body requires a partner ID and a title.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo add your partner ID in partner_id.
\nTo add your campaign name in title.
\nWhen you send the request to create it, you will get your campaign_id as a response.
\nBelow you can see a sample request without segments; is_all: true.
\ncurl --location --request POST 'https://web-push.api.useinsider.com/v1/single/campaign_id' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data-raw '{\n \"partner_id\": \"100000001\",\n \"title\": \"title of push\",\n \"description\": \"description of push\",\n \"image\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"banner\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"link\": \"https://image.useinsider.com\",\n \"include_unengage\": true,\n \"ttl\": \"1000\"\n}'\n\nBelow you can see a sample request with segments; is_all: false.
\ncurl --location --request POST 'https://web-push.api.useinsider.com/v1/single/campaign_id' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data-raw '{\n \"partner_id\": \"10000001\",\n \"title\": \"title of push\",\n \"description\": \"description of push\",\n \"image\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"banner\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"link\": \"https://image.useinsider.com\",\n \"include_unengage\": true,\n \"ttl\": \"1000\",\n \"language\": \"en_US\",\n \"target\": {\n \"attribute\": \"d_wp_browser\",\n \"values\": [\"Edg\"]\n }\n}'\n\nYou can see this kind of response when you successfully launched your campaign.
\n{\n \"success\": true,\n \"campaign_id\": 1697300275\n}\n\n{\n\"message\": \"Unauthorized\"\n}\n\n{\n \"message\": \"SERVICE:-\"\n}\n\n400: Bad request
\n401: Unauthorized request
\n424 Failed Dependency
\n429 Request limit exceeded
\nAll functions must be executed with an HTTPS POST request.
\nThe API key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 30 requests per minute second.
\nThis key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"100000001\",\n \"title\": \"title of push\",\n \"description\": \"description of push\",\n \"image\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"banner\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"link\": \"https://image.useinsider.com\",\n \"include_unengage\": true,\n \"ttl\": \"1000\"\n}"},"url":"https://web-push.api.useinsider.com/v2/single/campaign_id","description":"Insider's web push API allows you to launch single web push notifications from your own back-end without using Insider's InOne panel.
\nEach request body requires a partner ID and a title.
\nBefore sending the request, make sure:
\nWhen you send the request to create it, you will get your campaign_id as a response.
\nBelow you can see a sample request without segments; is_all: true.
\ncurl --location --request POST 'https://web-push.api.useinsider.com/v2/single/campaign_id' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data-raw '{\n \"partner_id\": \"100000001\",\n \"title\": \"title of push\",\n \"description\": \"description of push\",\n \"image\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"banner\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"link\": \"https://image.useinsider.com\",\n \"include_unengage\": true,\n \"ttl\": \"1000\"\n}'\n\nBelow you can see a sample request with segments; is_all: false.
\ncurl --location --request POST 'https://web-push.api.useinsider.com/v2/single/campaign_id' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data-raw '{\n \"partner_id\": \"10000001\",\n \"title\": \"title of push\",\n \"description\": \"description of push\",\n \"image\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"banner\": \"https://image.useinsider.com/mywebsite/webPushDefaultImage/JpVu9aBXgTXmcrBkiZLB1512577074.jpeg\",\n \"link\": \"https://image.useinsider.com\",\n \"include_unengage\": true,\n \"ttl\": \"1000\",\n \"language\": \"en_US\",\n \"target\": {\n \"attribute\": \"d_wp_browser\",\n \"values\": [\"Edg\"]\n }\n}'\n\nYou can see this kind of response when you successfully launched your campaign.
\n{\n \"success\": true,\n \"campaign_id\": 1697300275\n}\n\n{\n\"message\": \"Unauthorized\"\n}\n\n{\n \"message\": \"SERVICE:-\"\n}\n\nThis key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"100000001\",\n}"},"url":"https://web-push.api.useinsider.com/v1/single/campaign_id","description":"Insider's web push API allows you to delete single web push notifications from your own back-end without using Insider's InOne panel.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo add your partner ID in partner_id.
\nWhen you send the request to create it, you will get your campaign_id as a response.
\ncurl --location --request DELETE 'https://web-push.api.useinsider.com/v1/single/campaign_id' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data-raw '{\n \"partner_id\": \"100000001\",\n}'\n\nYou can see this kind of response when you successfully deleted your campaign.
\n{\n \"success\": true,\n \"campaign_id\": 1697300275\n}\n\n{\n\"message\": \"Unauthorized\"\n}\n\n{\n \"message\": \"SERVICE:-\"\n}\n\n400: Bad request
\n401: Unauthorized request
\n424 Failed Dependency
\n429 Request limit exceeded
\nAll functions must be executed with an HTTPS DELETE request.
\nThe API key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 30 requests per minute second.
\nInsider's Web Push API allows you to send push notifications that are triggered from your own systems without using the Insider's panel to a single user or a specific set of users. The data is used from your own back-end including transactional data, flight information, stock fluctuations and more.
\nWith Web Push API, you can:
\nCreate Single Web Pushes
\nLaunch Single Web Pushes
\nDelete Single Web Pushes
\nThis header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"{mobileAppApiKey}\",\n \"campaign_name\": \"Insider API Demo\",\n \"segment_name\": \"Your segment name goes here\",\n \"title\": \"Your push notification title goes here\",\n \"content\": \"Your push content goes here.\",\n \"deeplink\": {\n \"your_deeplink_key\": \"value\",\n \"your_another_deeplink_key\": \"value\"\n },\n \"notification_image\": \"https://your_image_url.jpg\",\n \"android_sound\": \"Your custom sound name for Android goes here\",\n \"ios_sound\": \"Your custom sound name for iOS goes here\",\n \"test_push\": true,\n \"override_global_freq_cap\": true,\n \"advanced_push_items\": [\n {\n \"headline\": \"Title for the item 1\",\n \"description\": \"Description for the item 1\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value\"\n }\n },\n {\n \"headline\": \"Title for the item 2\",\n \"description\": \"Description for the item 2\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value\"\n }\n },\n {\n \"headline\": \"Title for the item 3\",\n \"description\": \"Description for the item 3\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value\"\n }\n }\n ],\n \"preferred_type\": \"carousel\"\n}"},"url":"https://mobile.useinsider.com/api/v1/push/bulk","description":"Bulk Push API is a service that sends push notifications to a predefined segment over the web using predefined web services.
\nYou can reach the analytics of your bulk push notifications sent via this API through Reports > Mobile App Analytics > Push API Campaigns on Inone.
\nThe following are the body parameters you need to use in your request.
\nThe following is a sample body to send bulk app push notification. Before sending the request, make sure to replace the values in your request body.
\n{\n \"api_key\":\"Your API Key goes here\",\n \"campaign_name\":\"Insider API Demo\",\n \"segment_name\":\"All People\",\n \"title\":\"Your push notification title goes here\",\n \"content\":\"Your push content goes here.\",\n \"deeplink\":{\n \"your_deeplink_key\":\"value\",\n \"your_another_deeplink_key\":\"value\"\n },\n \"notification_image\":\"https://your_image_url.jpg\",\n \"android_sound\":\"Your custom sound name for Android goes here\",\n \"ios_sound\":\"Your custom sound name for iOS goes here\",\n \"test_push\":true,\n \"override_global_freq_cap\":true,\n \"advanced_push_items\":[\n {\n \"headline\":\"Title for the item 1\",\n \"description\":\"Description for the item 1\",\n \"image_url\":\"https://your_image_url.jpg\",\n \"deep_links\":{\n \"your_deeplink_key\":\"value\"\n }\n },\n {\n \"headline\":\"Title for the item 2\",\n \"description\":\"Description for the item 2\",\n \"image_url\":\"https://your_image_url.jpg\",\n \"deep_links\":{\n \"your_deeplink_key\":\"value\"\n }\n },\n {\n \"headline\":\"Title for the item 3\",\n \"description\":\"Description for the item 3\",\n \"image_url\":\"https://your_image_url.jpg\",\n \"deep_links\":{\n \"your_deeplink_key\":\"value\"\n }\n }\n ],\n \"preferred_type\":\"carousel\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"response\": \"Campaign Created.\"\n}\n\nThe following response returns if the API Key is invalid.
\n{\n \"response\": \"No Partner Found With Api Key.\"\n}\n\n{\n \"response\": \"No Push Message Certificate is Provided.\"\n}\nThe following are fail records that might return in the response.
\nWhen sending your request, make sure to follow these limitations.
\nThis header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"{mobileAppApiKey}\",\n \"report_attributes\": [\n \"INSIDER.carrier\",\n \"INSIDER.idfa\",\n \"INSIDER.name\",\n \"INSIDER.surname\",\n \"INSIDER.gender\",\n \"INSIDER.age\",\n \"INSIDER.birthday\",\n \"INSIDER.email\",\n \"INSIDER.phone_number\",\n \"INSIDER.language\",\n \"INSIDER.email_optin\",\n \"INSIDER.sms_optin\",\n \"INSIDER.push_optin\",\n \"INSIDER.location_optin\",\n \"INSIDER.insider_id\",\n \"INSIDER.environment\",\n \"INSIDER.idfa\",\n \"INSIDER.device_token\",\n \"INSIDER.udid\",\n \"INSIDER.model\",\n \"INSIDER.carrier\",\n \"INSIDER.app_version\",\n \"INSIDER.os_version\",\n \"INSIDER.screen_width\",\n \"INSIDER.screen_height\",\n \"INSIDER.platform\",\n \"INSIDER.timezone\",\n \"INSIDER.device_language\",\n \"INSIDER.sdk_version\",\n \"INSIDER.last_ip\",\n \"INSIDER.package_name\",\n \"INSIDER.push_enabled\",\n \"INSIDER.location_enabled\"\n ],\n \"notifications\": [\n {\n \"identifiers\": {\n \"INSIDER.email\": \"sample@useinsider.com\",\n \"INSIDER.phone_number\": \"+65123456789\",\n \"INSIDER.uuid\": \"1234567890\"\n },\n \"camp_id\": 1,\n \"camp_name\": \"Your push notification campaign name goes here\",\n \"title\": \"Your push notification title goes here\",\n \"message\": \"Your push content goes here.\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"ttl\": 1,\n \"check_optin\": true,\n \"android\": {\n \"thread-id\": 1,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n },\n \"ios\": {\n \"thread-id\": 1,\n \"badge\": 1,\n \"content-available\": false,\n \"mutable-content\": true,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n }\n }\n ]\n}"},"url":"https://mobile.useinsider.com/api/v2/notification/user","description":"You can use the Targeted Push API in various cases such as sending status update of an order from your e-commerce platform, or informing users of a sale on an item that was in their wishlist.
\nYou can reach the analytics of your targeted push notifications sent via this API through Reports > Mobile App Analytics > Push API Campaigns on Inone.
\nThe following are the body parameters you need to have in your request body.
\nTo add key-value pairs to the deep_link object, you can use the following deep link keys depending on its type:
\nins_dl_internal for an internal deep link,
ins_dl_external for an external deep link,
ins_dl_url_scheme for a URL scheme deep link,
ins_dl_json for a JSON deep link.
The URL in the value should always start with https://.
The following is a sample body to send targeted app push notifications.
\n\n\ncamp_id allows you to list your app push notifications in the Message Center, and get campaign-based reporting of your Push API campaigns. When replacing the sample values in the payload, make sure to use a unique campaign ID value in the camp_id key.
\n
{\n \"api_key\": \"Your API Key goes here\",\n \"report_attributes\": [\n \"INSIDER.carrier\",\n \"INSIDER.idfa\",\n \"INSIDER.name\",\n \"INSIDER.surname\",\n \"INSIDER.gender\",\n \"INSIDER.age\",\n \"INSIDER.birthday\",\n \"INSIDER.email\",\n \"INSIDER.phone_number\",\n \"INSIDER.language\",\n \"INSIDER.email_optin\",\n \"INSIDER.sms_optin\",\n \"INSIDER.push_optin\",\n \"INSIDER.location_optin\",\n \"INSIDER.insider_id\",\n \"INSIDER.environment\",\n \"INSIDER.idfa\",\n \"INSIDER.device_token\",\n \"INSIDER.udid\",\n \"INSIDER.model\",\n \"INSIDER.carrier\",\n \"INSIDER.app_version\",\n \"INSIDER.os_version\",\n \"INSIDER.screen_width\",\n \"INSIDER.screen_height\",\n \"INSIDER.platform\",\n \"INSIDER.timezone\",\n \"INSIDER.device_language\",\n \"INSIDER.sdk_version\",\n \"INSIDER.last_ip\",\n \"INSIDER.package_name\"\n ],\n \"notifications\": [\n {\n \"identifiers\": {\n \"INSIDER.email\": \"sample@mail.com\",\n \"INSIDER.phone_number\": \"+65123456789\",\n \"INSIDER.uuid\": \"1234567890\"\n },\n \"camp_id\": 1,\n \"camp_name\": \"Your push notification campaign name goes here\",\n \"title\": \"Your push notification title goes here\",\n \"message\": \"Your push content goes here.\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"ttl\": 1,\n \"check_optin\": true,\n \"android\": {\n \"thread-id\": 1,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n },\n \"ios\": {\n \"thread-id\": 1,\n \"badge\": 1,\n \"content-available\": false,\n \"mutable-content\": true,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n }\n }\n ]\n}\n\nAdd advanced_push_payload in notifications if you would like to use advanced app pushes. The advanced_push_type value can be a carousel or slider.
\n{\n \"api_key\": \"Your API Key goes here\",\n \"report_attributes\": [\n \"INSIDER.carrier\",\n \"INSIDER.idfa\",\n \"INSIDER.name\",\n \"INSIDER.surname\",\n \"INSIDER.gender\",\n \"INSIDER.age\",\n \"INSIDER.birthday\",\n \"INSIDER.email\",\n \"INSIDER.phone_number\",\n \"INSIDER.language\",\n \"INSIDER.email_optin\",\n \"INSIDER.sms_optin\",\n \"INSIDER.push_optin\",\n \"INSIDER.location_optin\",\n \"INSIDER.insider_id\",\n \"INSIDER.environment\",\n \"INSIDER.idfa\",\n \"INSIDER.device_token\",\n \"INSIDER.udid\",\n \"INSIDER.model\",\n \"INSIDER.carrier\",\n \"INSIDER.app_version\",\n \"INSIDER.os_version\",\n \"INSIDER.screen_width\",\n \"INSIDER.screen_height\",\n \"INSIDER.platform\",\n \"INSIDER.timezone\",\n \"INSIDER.device_language\",\n \"INSIDER.sdk_version\",\n \"INSIDER.last_ip\",\n \"INSIDER.package_name\"\n ],\n \"notifications\": [\n {\n \"identifiers\": {\n \"INSIDER.email\": \"example@gmail.com\",\n \"INSIDER.phone_number\": \"+9059713551597135123\",\n \"INSIDER.uuid\": \"5971351231234567\"\n },\n \"advanced_push_payload\": {\n \"advanced_push_type\": \"carousel\",\n \"advanced_push_items\": [\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value1\"\n },\n \"description\": \"Description for the item 1\",\n \"headline\": \"Title for the item 1\",\n \"id\": 1\n },\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value2\"\n },\n \"description\": \"Description for the item 2\",\n \"headline\": \"Title for the item 2\",\n \"id\": 2\n },\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value3\"\n },\n \"description\": \"Description for the item 3\",\n \"headline\": \"Title for the item 3\",\n \"id\": 3\n }\n ]\n },\n \"camp_id\": 1,\n \"camp_name\": \"Your push notification campaign name goes here\",\n \"title\": \"Your push notification title goes here\",\n \"message\": \"Your push content goes here\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"ttl\": 1,\n \"send_single_user\": true,\n \"check_optin\": true,\n \"android\": {\n \"thread-id\": 1,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n },\n \"ios\": {\n \"thread-id\": 13,\n \"badge\": 1,\n \"content-available\": false,\n \"mutable-content\": true,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n }\n }\n ]\n}\n\n\n\nYou can replace the advanced_push_payload.advanced_push_items[n].deep_links.your_deeplink_key with a custom deep link key, or use one of the following default keys: ins_dl_internal, ins_dl_external, ins_dl_url_scheme, or ins_dl_json.
\n
The following response returns if the request body has the report_attributes array.
\n\n\ninsider_id represents the profile ID in user profiles.
\n
{\n \"successes\": [\n {\n \"INSIDER.age\": 37,\n \"INSIDER.app_version\": \"4.0\",\n \"INSIDER.birthday\": \"1982-11-13T23:00:00Z\",\n \"INSIDER.carrier\": \"mycarrier\",\n \"INSIDER.device_language\": \"en\",\n \"INSIDER.device_token\": \"d07951020f3835bbc303084ecda3746170cfb5d696ddcc55b6\",\n \"INSIDER.email\": \"sample@mail.com\",\n \"INSIDER.email_optin\": true,\n \"INSIDER.environment\": \"production\",\n \"INSIDER.gender\": \"F\",\n \"INSIDER.idfa\": \"AF3CCF3F-0V8E-6571-B296-E9BDFF7\",\n \"INSIDER.insider_id\": \"940E4A98F309288AAC8C4\",\n \"INSIDER.language\": \"en_US\",\n \"INSIDER.last_ip\": null,\n \"INSIDER.location_optin\": false,\n \"INSIDER.model\": \"iPhone 11\",\n \"INSIDER.name\": \"John Smith\",\n \"INSIDER.os_version\": \"14.7.1\",\n \"INSIDER.package_name\": \"com.useinsider.iGurmeV3\",\n \"INSIDER.phone_number\": \"+65123456789\",\n \"INSIDER.platform\": \"iOS\",\n \"INSIDER.push_optin\": true,\n \"INSIDER.screen_height\": null,\n \"INSIDER.screen_width\": null,\n \"INSIDER.sdk_version\": \"10.6.0-RN-4.0.0\",\n \"INSIDER.sms_optin\": true,\n \"INSIDER.surname\": \"Smith\",\n \"INSIDER.timezone\": \"Europe/Helsinki\",\n \"INSIDER.udid\": \"98BB170F5078F309288AAC8C4\"\n }\n ],\n \"errors\": {}\n}\n\nThe following response returns if the request body does not have the report_attributes array.
\n{\n \"successes\": [\n {\n \"INSIDER.device_token\": \"d07951020f3084ecd4d3deda3746170cfb5d69672c055b6\"\n }\n ],\n \"errors\": {}\n}\n\nThere might be cases where the request returns a 200 response but the app pushes cannot be sent to users. The following list displays the reasons for these cases.
\n| noUserErr | \"NoUserFound\" |
| optOutErr | \"OptOut\" |
| unregisteredErr | \"Unregistered\" |
| userGloballyCappedErr | \"UserGloballyCapped\" |
| userGloballyCappedForInappErr | \"UserGloballyCappedForInapp\" |
| invalidCertificateErr | \"InvalidCertificate\" |
The following response returns if the request body does not have an identifier.
\n{\n \"error\": \"empty_insider_identifiers\",\n \"message\": \"'insider_identifiers' object need to have at least one identifier\"\n}\n\nThe following response returns if the notifications array is empty.
\n{\n \"error\": \"invalid_notifications\",\n \"message\": \"'notifications' is empty, add some notification objects\"\n}\n\nThe following response returns if the array has more than 20 objects.
\n{\n \"error\": \"invalid_notifications\",\n \"message\": \"'notifications' can't have more than 20 objects\"\n}\n\nThe following response returns if the deep link is blacklisted.
\n{\n \"error\": \"blacklisted_deeplink\",\n \"message\": \"deepLink can't contain 'aps' key\"\n}\n\nThe following response returns if the camp ID or channel ID is a negative integer.
\n{\n \"error\": \"negative_integer\",\n \"message\": \"camp_id' and/or 'channel_id' must be greater than zero\"\n}\n\nThe following response returns if the advanced push type is invalid.
\n{\n \"error\": \"invalid_advanced_push_type\",\n \"message\": \"'advanced_push_type' must be either Carousel or Slider\"\n}\n\nThe following response returns if the certificate is invalid.
\n{\n \"error\": \"invalid_certificate\",\n \"message\": \"You do not have a validated certificate. Please check Certificate section under Insider's Settings.\"\n}\n\nThe following response returns if the API Key is either empty or incorrect.
\n{\n \"error\": \"bad_api_key\",\n \"message\": \"'api_key' is either empty or wrong. You can get your API key from Insider Dashboard\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nThe API key should be provided in the request body. If the key is incorrect, no operation will be executed.
\nYou must complete the identifier integration with Insider SDK's user object for your platforms. See Android, iOS, React Native, Flutter, and Cordova for further details.
\nThe camp ID value should be greater than 0.
\nThe advanced_push_type value can be slider or carousel.
\nThe Android channel ID value should be greater than 0.
\nThis header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"{mobileAppApiKey}\",\n \"report_attributes\": [\n \"INSIDER.carrier\",\n \"INSIDER.idfa\",\n \"INSIDER.name\",\n \"INSIDER.surname\",\n \"INSIDER.gender\",\n \"INSIDER.age\",\n \"INSIDER.birthday\",\n \"INSIDER.email\",\n \"INSIDER.phone_number\",\n \"INSIDER.language\",\n \"INSIDER.email_optin\",\n \"INSIDER.sms_optin\",\n \"INSIDER.push_optin\",\n \"INSIDER.location_optin\",\n \"INSIDER.insider_id\",\n \"INSIDER.environment\",\n \"INSIDER.idfa\",\n \"INSIDER.device_token\",\n \"INSIDER.udid\",\n \"INSIDER.model\",\n \"INSIDER.carrier\",\n \"INSIDER.app_version\",\n \"INSIDER.os_version\",\n \"INSIDER.screen_width\",\n \"INSIDER.screen_height\",\n \"INSIDER.platform\",\n \"INSIDER.timezone\",\n \"INSIDER.device_language\",\n \"INSIDER.sdk_version\",\n \"INSIDER.last_ip\",\n \"INSIDER.package_name\",\n \"INSIDER.push_enabled\",\n \"INSIDER.location_enabled\"\n ],\n \"notifications\": [\n {\n \"identifiers\": {\n \"INSIDER.email\": \"sample@useinsider.com\",\n \"INSIDER.phone_number\": \"+6559713551597135123\",\n \"INSIDER.uuid\": \"5971351231234567\"\n },\n \"advanced_push_payload\": {\n \"advanced_push_type\": \"carousel\",\n \"advanced_push_items\": [\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value1\"\n },\n \"description\": \"Description for the item 1\",\n \"headline\": \"Title for the item 1\",\n \"id\": 1\n },\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value2\"\n },\n \"description\": \"Description for the item 2\",\n \"headline\": \"Title for the item 2\",\n \"id\": 2\n },\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value3\"\n },\n \"description\": \"Description for the item 3\",\n \"headline\": \"Title for the item 3\",\n \"id\": 3\n }\n ]\n },\n \"camp_id\": 1,\n \"camp_name\": \"Your push notification campaign name goes here\",\n \"title\": \"Your push notification title goes here\",\n \"message\": \"Your push content goes here\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"ttl\": 1,\n \"check_optin\": true,\n \"android\": {\n \"thread-id\": 1,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n },\n \"ios\": {\n \"thread-id\": 13,\n \"badge\": 1,\n \"deliver_silently\": true,\n \"mutable-content\": true,\n \"sound\": \"sound_check\",\n \"content-available\": true,\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n }\n }\n ]\n}"},"url":"https://mobile.useinsider.com/api/v2/notification/user","description":"You can use this endpoint in various cases such as sending status update of an order from your ecommerce platform, or informing users of a sale on an item that was in their wishlist.
\nYou can reach the analytics of your advanced push notifications sent via this API through Reports > Mobile App Analytics > Push API Campaigns on Inone.
\nThe following are the body parameters you need to use in your request body.
\nTo add key-value pairs to the deep_link object, you can use the following deep link keys depending on its type:
\nins_dl_internal for an internal deep link,ins_dl_external for an external deep link,ins_dl_url_scheme for a URL scheme deep link,ins_dl_json for a JSON deep link.The URL in the value should always start with https://.
\n\nYou can replace the advanced_push_payload.advanced_push_items[n].deep_links.your_deeplink_key with a custom deep link key, or use one of the following default keys: ins_dl_internal, ins_dl_external, ins_dl_url_scheme, or ins_dl_json.
\n
The following is a sample body to send advanced app push notifications.
\n\n\ncamp_id allows you to list your app push notifications in the Message Center, and get campaign-based reporting of your Push API campaigns. When replacing the sample values in the payload, make sure to use a unique campaign ID value in the camp_id key.
\n
{\n \"api_key\": \"Your API Key goes here\",\n \"report_attributes\": [\n \"INSIDER.carrier\",\n \"INSIDER.idfa\",\n \"INSIDER.name\",\n \"INSIDER.surname\",\n \"INSIDER.gender\",\n \"INSIDER.age\",\n \"INSIDER.birthday\",\n \"INSIDER.email\",\n \"INSIDER.phone_number\",\n \"INSIDER.language\",\n \"INSIDER.email_optin\",\n \"INSIDER.sms_optin\",\n \"INSIDER.push_optin\",\n \"INSIDER.location_optin\",\n \"INSIDER.insider_id\",\n \"INSIDER.environment\",\n \"INSIDER.idfa\",\n \"INSIDER.device_token\",\n \"INSIDER.udid\",\n \"INSIDER.model\",\n \"INSIDER.carrier\",\n \"INSIDER.app_version\",\n \"INSIDER.os_version\",\n \"INSIDER.screen_width\",\n \"INSIDER.screen_height\",\n \"INSIDER.platform\",\n \"INSIDER.timezone\",\n \"INSIDER.device_language\",\n \"INSIDER.sdk_version\",\n \"INSIDER.last_ip\",\n \"INSIDER.package_name\"\n ],\n \"notifications\": [\n {\n \"identifiers\": {\n \"INSIDER.email\": \"example@gmail.com\",\n \"INSIDER.phone_number\": \"+9059713551597135123\",\n \"INSIDER.uuid\": \"5971351231234567\"\n },\n \"advanced_push_payload\": {\n \"advanced_push_type\": \"carousel\",\n \"advanced_push_items\": [\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value1\"\n },\n \"description\": \"Description for the item 1\",\n \"headline\": \"Title for the item 1\",\n \"id\": 1\n },\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value2\"\n },\n \"description\": \"Description for the item 2\",\n \"headline\": \"Title for the item 2\",\n \"id\": 2\n },\n {\n \"image_url\": \"https://your_image_url.jpg\",\n \"deep_links\": {\n \"your_deeplink_key\": \"value3\"\n },\n \"description\": \"Description for the item 3\",\n \"headline\": \"Title for the item 3\",\n \"id\": 3\n }\n ]\n },\n \"camp_id\": 1,\n \"camp_name\": \"Your push notification campaign name goes here\",\n \"title\": \"Your push notification title goes here\",\n \"message\": \"Your push content goes here\",\n \"image_url\": \"https://your_image_url.jpg\",\n \"ttl\": 1,\n \"check_optin\": true,\n \"android\": {\n \"thread-id\": 1,\n \"sound\": \"sound_check\",\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n },\n \"ios\": {\n \"thread-id\": 13,\n \"badge\": 1,\n \"deliver_silently\": true,\n \"mutable-content\": true,\n \"sound\": \"sound_check\",\n \"content-available\": true,\n \"deep_link\": {\n \"ins_dl_internal\": \"https://www.deeplink.useinsider\"\n }\n }\n }\n ]\n}\n\nThe following response returns if the request is successful.
\n{\n \"successes\": [\n {\n \"INSIDER.carrier\": \"Mybrand\",\n \"INSIDER.device_token\": \"1a2b3c4d5e6f\",\n \"INSIDER.email\": \"sample@mail.com\",\n \"INSIDER.phone_number\": \"+651234567891\",\n }\n },\n \"errors\": {\n \"NoUserFound\": [\n {\n \"INSIDER.email\": \"sample2@mail.com\"\n }\n ]\n }\n}\n\nThere might be cases where the request returns a 200 response but the app pushes cannot be sent to users. The following list displays the reasons for these cases.
\n| noUserErr | \"NoUserFound\" |
| optOutErr | \"OptOut\" |
| unregisteredErr | \"Unregistered\" |
| userGloballyCappedErr | \"UserGloballyCapped\" |
| userGloballyCappedForInappErr | \"UserGloballyCappedForInapp\" |
| invalidCertificateErr | \"InvalidCertificate\" |
The following response returns if the payload is invalid.
\n{\n \"error\": \"invalid_payload\"\n \"message\": \"Can't parse payload, check your keys and data types\"\n}\n\nThe following response returns if the notifications array is empty.
\n{\n \"error\": \"invalid_notifications\",\n \"message\": \"'notifications' is empty, add some notification objects\"\n}\n\nThe following response returns if the array has more than 20 objects.
\n{\n \"error\": \"invalid_notifications\",\n \"message\": \"'notifications' can't have more than 20 objects\"\n}\n\nThe following response returns if the deep link is blacklisted.
\n{\n \"error\": \"blacklisted_deeplink\",\n \"message\": \"deepLink can't contain 'aps' key\"\n}\n\nThe following response returns if the camp ID or channel ID is a negative integer.
\n{\n \"error\": \"negative_integer\",\n \"message\": \"camp_id' and/or 'channel_id' must be greater than zero\"\n}\n\nThe following response returns if the advanced push type is invalid.
\n{\n \"error\": \"invalid_advanced_push_type\",\n \"message\": \"'advanced_push_type' must be either Carousel or Slider\"\n}\n\nThe following response returns if the certificate is invalid.
\n{\n \"error\": \"invalid_certificate\",\n \"message\": \"You do not have a validated certificate. Please check Certificate section under Insider's Settings.\"\n}\n\nWhen sending your request, make sure to follow these limitations.
\nThis key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identifiers\": {\n \"Email\": \"j.doe@mail.com\"\n },\n \"start_date\": 1633068172,\n \"end_date\": 2143433430,\n \"limit\": 100\n}"},"url":"https://mobile.useinsider.com/api/message_center/v1","description":"This API allows you to get the push notifications of any type delivered to your users during a defined time interval, including the push notifications delivered in Architect journeys.
\nBefore sending the request, make sure to replace the values in your request body.
\nThe following is a sample body to get your message center data.
\n{\n \"identifiers\": {\n \"Email\": \"j.doe@mail.com\"\n },\n \"start_date\": 1633068172,\n \"end_date\": 2143433430,\n \"limit\": 100\n}\n\nThe following sample response returns for a successful request with a limit of 3.
\n[\n {\n \"camp_id\": 650,\n \"camp_type\": \"Single Push\",\n \"created_at\": \"2023-01-23T18:10:17Z\",\n \"deep_links\": {\n \"Page\": \"Cart\",\n \"category\": \"insider_int_push\",\n \"mutable-content\": \"1\"\n },\n \"message\": \"This is my message\",\n \"title\": \"This is my title\",\n \"variant_id\": 1907\n },\n {\n \"camp_id\": 101,\n \"camp_type\": \"Recurring Push\",\n \"created_at\": \"2023-01-18T21:00:21Z\",\n \"deep_links\": {\n \"MyKey01\": \"MyValue01\"\n },\n \"message\": \"New women's clothing has launched...\",\n \"title\": \"Don't forget about me!\",\n \"variant_id\": 898\n },\n {\n \"camp_id\": 132,\n \"camp_type\": \"Recurring Push\",\n \"created_at\": \"2023-01-18T21:00:20Z\",\n \"deep_links\": {\n \"Page\": \"Cart\",\n \"MyKey02\": \"MyValue02\"\n },\n \"message\": \"Your favorite items are waiting for you. \",\n \"title\": \"Retail\",\n \"variant_id\": 1122\n }\n]\n\nThe following sample response returns for a request where the start date is greater than the end date.
\nbad payload\n\nThe following sample response returns for a request where the limit is greater than 100.
\nlimit should be between 1 and 100.\n\nA request with an invalid API key will return a 401 Unauthorized response.
\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nEach request can get push notifications only for one single user.
\nThis key is required to authorize your request.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"created_between\": {\n \"from\": \"2025-01-16\",\n \"to\": \"2025-04-15\"\n }\n}"},"url":"https://mobile.api.useinsider.com/v1/details/inapp","description":"This API allows you to retrieve detailed information about your app template campaigns. The campaigns in the App Templates, App Survey, App Template from Push, and Architect journeys can return in the response if available.
\nYou can either:
\nSearch for a specific campaign using its ID or
\nFilter campaigns created within a specific date range.
\nBefore sending the request, make sure to replace the values in your request body.
\nBefore sending the request, make sure to replace the values in your request body. Below is an example for the created_between parameter.
\n{\n \"created_between\": {\n \"from\": \"2025-01-16\",\n \"to\": \"2025-04-15\"\n }\n}\n\nBelow is an example for the inapp_id parameter.
\n{\n \"inapp_id\": 1434\n}\nThe following are some example responses you might receive for your request.
\nThe following is a sample response for the created_between parameter.
\n{\n \"data\": [\n {\n \"inapp_id\": 2,\n \"linked_push_id\": 3,\n \"linked_push_type\": \"conversion\",\n \"name\": \"My campaign\",\n \"created_by\": \"test@useinsider.com\",\n \"status\": \"passive\",\n \"is_inapp_from_push\": true,\n \"is_inapp_from_architect\": false,\n \"created_at\": \"2025-01-01T15:08:55Z\",\n \"start_date\": \"2024-01-01T15:08:56Z\",\n \"updated_at\": \"2023-01-05T15:08:55Z\",\n \"end_date\": \"2024-01-01T15:08:57Z\",\n \"variations\": [\n {\n \"variation_id\": 1,\n \"percentage\": 50,\n \"variation_name\": \"Variant A\",\n \"type\": \"wheelOfFortune\"\n },\n {\n \"variation_id\": 2,\n \"percentage\": 50,\n \"variation_name\": \"Control Group\",\n \"type\": \"wheelOfFortune\"\n }\n ],\n \"tags\": [\n \"tagName2\"\n ]\n },\n {\n \"inapp_id\": 3,\n \"name\": \"Our campaign\",\n \"created_by\": \"test@useinsider.com\",\n \"status\": \"draft\",\n \"is_inapp_from_push\": false,\n \"is_inapp_from_architect\": false,\n \"created_at\": \"2025-01-02T15:08:55Z\",\n \"start_date\": \"2024-01-01T15:08:56Z\",\n \"updated_at\": \"2023-01-05T15:08:55Z\",\n \"end_date\": \"2024-01-01T15:08:57Z\",\n \"variations\": [\n {\n \"variation_id\": 3,\n \"percentage\": 50,\n \"variation_name\": \"Variant A\",\n \"type\": \"wheelOfFortune\"\n },\n {\n \"variation_id\": 4,\n \"percentage\": 50,\n \"variation_name\": \"Control Group\",\n \"type\": \"wheelOfFortune\"\n }\n ],\n \"tags\": [\n \"tagName3\"\n ]\n },\n {\n \"inapp_id\": 4,\n \"journey_id\": 15,\n \"name\": \"This campaign\",\n \"created_by\": \"test@useinsider.com\",\n \"status\": \"active\",\n \"is_inapp_from_push\": false,\n \"is_inapp_from_architect\": true,\n \"created_at\": \"2025-01-03T15:08:55Z\",\n \"start_date\": \"2024-01-01T15:08:56Z\",\n \"updated_at\": \"2023-01-05T15:08:55Z\",\n \"variations\": [\n {\n \"variation_id\": 5,\n \"percentage\": 50,\n \"variation_name\": \"Variant A\",\n \"type\": \"wheelOfFortune\"\n }\n ]\n }\n ]\n}\n\nThe following is a sample response for the inapp_id parameter.
\n{\n \"data\": [\n {\n \"inapp_id\": 2,\n \"name\": \"My campaign\",\n \"linked_push_id\": 3,\n \"linked_push_type\": \"conversion\",\n \"created_at\": \"2024-01-01T15:08:55Z\",\n \"created_by\": \"test@useinsider.com\",\n \"status\": \"passive\",\n \"is_inapp_from_push\": true,\n \"is_inapp_from_architect\": false,\n \"start_date\": \"2024-01-01T15:08:56Z\",\n \"end_date\": \"2024-01-01T15:08:57Z\",\n \"updated_at\": \"2023-01-05T15:08:55Z\",\n \"variations\": [\n {\n \"variation_id\": 1,\n \"percentage\": 50,\n \"variation_name\": \"Variant A\",\n \"type\": \"wheelOfFortune\"\n },\n {\n \"variation_id\": 2,\n \"percentage\": 50,\n \"variation_name\": \"Control Group\",\n \"type\": \"wheelOfFortune\"\n }\n ],\n \"tags\": [\n \"tagName2\"\n ]\n }\n ]\n}\nhe following is a sample response for a request where the API key is missing.
\n{\n \"error\": \"No api key provided\"\n}\n\nThe following is a sample response for a request where the payload is invalid.
\n{\n \"error\": \"invalid request payload\"\n}\n\nThe following is a sample response for a request where the required parameter is missing.
\n{\n \"error\": \"either 'inapp_id' or 'created_between' must be provided\"\n}\nThe following is a sample response for a request where the payload has both parameters while it requires only one.
\n{\n \"error\": \"provide either 'inapp_id' or 'created_between', not both\"\n}\nThe following is a sample response for a request where the date format is incorrect for the from parameter.
\n{\n \"error\": \"invalid date format for 'from'; expected format is YYYY-MM-DD\"\n}\nThe following is a sample response for a request where the date format is incorrect for the to parameter.
\n{\n \"error\": \"invalid date format for 'to'; expected format is YYYY-MM-DD\"\n}\nThe following is a sample response for a request where the to date is not greater than or equal to the from date.
\n{\n \"error\": \"'to' date must be after or equal to 'from' date\"\n}\nThe following is a sample response for a request where the date range exceeds 90 days.
\n{\n \"error\": \"date range must not exceed 90 days\"\n}\nThe following is a sample response for a request where no inapp is found.
\n{\n \"error\": \"inapp not found\"\n}\nThe following is a sample response for a request where the API key is invalid.
\n{\n \"error\": \"Invalid api key\"\n}\nAll functions must be executed with a simple HTTPS POST request.
\nnly one of the filters (inapp_id or created_between) can be used at a time.
\nThe date range must be 90 days or less.
\nThis API allows you to upload your FCM certificate to Insider without visiting the Inone panel. With this API, you can upload or change your certificate.
\n","urlObject":{"protocol":"https","path":["v1","settings","certificate","firebase"],"host":["mobile","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"293c82f0-a929-4c5e-ba58-a926fbc0bd8b"}],"id":"e742c647-5f61-4519-85c8-cefbb480977a","description":"With these APIs, you can send bulk, targeted, and advanced app pushes, and get Message Center data.
\n","_postman_id":"e742c647-5f61-4519-85c8-cefbb480977a"},{"name":"SMS APIs","item":[{"name":"Transactional SMS","item":[{"name":"Send transactional Single SMS","id":"83224693-8a3e-42f8-90b1-1427e520c354","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"INS.**************************","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"This is SMS body.\",\n \"to\": \"+105555555555\",\n \"callback\": \"http://callback.url\",\n \"sendAt\" : \"2024-03-30T11:30:27Z\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"settings\": {\n \"urlExcludeProtocol\": true,\n \"urlShorteningDomain\": \"insdr.io\",\n \"urlShorteningStatus\": true,\n \"urlTrackingStatus\": true,\n \"smartEncoding\": true\n }\n}"},"url":"https://sms.useinsider.com/v1/send","description":"This API enables you to send targeted transactional SMS to your users. You can trigger these SMS messages once a user takes a specific action on your platform.
\nYou can use transactional SMS messages to:
\nSend a post-purchase SMS to share details about a purchase/booking,
\nHelp your users reset their password if they forget it,
\nConfirm an order a user places,
\nShare delivery tracking details of a purchase (when it is shipped, on the way, and delivered) and take many other actions.
\nYou can send transactional SMS messages for:
\nSystem notifications
\nOrder confirmation/information
\nThank you for your purchase! Your order number is {orderNumber}. View more information about your order here: {Link}
\nHey, {firstName}! Thanks for your purchase! View more information about your order ({orderNumber}) here: {Link}
\nShipping Confirmation
\nGreat news, {firstName}! Your order ({orderNumber}) has shipped and will arrive soon. Click here to view your order details: {Link}
\nGet excited! Your order ({orderNumber}) has shipped and is on its way to you. Click here to view your order details: {Link}
\nTicket booking confirmation or cancellation
\nInformation about shipping and delivery updates
\nRecurring billing / Payment Updates
\nAppointment confirmations
\nWelcome Messages
\nYou need to use the following parameters in the request body.
\nThe current status of your SMS messages is provided to you through the API URL you specify in the callback parameter while they are being sent. If you don't respond to code between 200 and 300, the system retries the request 10 times. The retry policy process is as follows:
\nThe first request is tried again 1 minute later.
\nThe second request is tried again 2 minutes later after the first attempt.
\nThe third request is tried again 3 minutes later after the first attempt.
\nThe fourth request is tried again 8 minutes later after the first attempt.
\nThe fifth request is tried again 13 minutes later after the first attempt.
\nThe sixth request is tried again 18 minutes later after the first attempt.
\nThe seventh request is tried again 28 minutes later after the first attempt.
\nThe eighth request is tried again 38 minutes later after the first attempt.
\nThe ninth request is tried again 48 minutes later after the first attempt.
\nThe tenth request is tried again an hour later after the first attempt.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your sms content.
\n{\n \"content\": \"This is SMS body.\",\n \"to\": \"+105555555555\",\n \"callback\": \"http://callback.url\",\n \"sendAt\" : \"2024-03-30T11:30:27Z\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"settings\": {\n \"urlShorteningDomain\": \"insdr.io\",\n \"urlShorteningStatus\": true,\n \"urlTrackingStatus\": true\n }\n}\n\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\nThis response indicates that your request was successfully completed.
\n{\n \"message\": \"Accepted\",\n \"messageId\": \"sms-a1234567-b123-c123-d123-e123f123456\"\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"sent\",\n \"partCount\": 1\n}\n\nThis response indicates that your request was successfully completed.
\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"delivered\"\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"undelivered\",\n \"reason\": {\n \"message\": \"Soft Bounce\",\n \"code\": 1404\n }\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"failed\",\n \"reason\": {\n \"message\": \"Invalid Phone Number\",\n \"code\": 1500\n },\n \"partCount\": 1\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"scheduled\",\n \"sendAt\": \"2006-01-02T15:04:05Z\",\n \"partCount\": 1\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"sent\",\n \"sendAt\": \"2006-01-02T15:04:05Z\",\n \"partCount\": 1\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nTransactional API cannot be used to send promotional SMS. It is designed to set transactional SMS only.
\nThe phone number should be in E164 format.
\nContent can’t be empty. The maximum limit is 670 characters.
\nThe rate limit is 5 requests per second.
\nThe maximum speed will be determined based on the Provider Setup.
\nInsider will send a sample request to the callback URL you provide. If the response does not return a 200 (Success) code, the Insider system will respond with \"Callback URL value is not valid\".
\nThis key is required to authorize your request. If needed to test Transactional SMS, please request an API key from Insider team.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+905555555555\",\n \"content\": \"This is SMS body.\",\n \"callback\": \"http://callback.url\",\n \"settings\": {\n \"urlExcludeProtocol\": true,\n \"urlShorteningDomain\": \"insdr.io\",\n \"urlShorteningStatus\": true,\n \"urlTrackingStatus\": true,\n \"smartEncoding\": true\n },\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n },\n {\n \"phoneNumber\": \"90 (555) 55\",\n \"content\": \"This is SMS body.\",\n \"callback\": \"http://callback.url\",\n \"settings\": {\n \"urlExcludeProtocol\": true,\n \"urlShorteningDomain\": \"insdr.io\",\n \"urlShorteningStatus\": true,\n \"urlTrackingStatus\": true,\n \"smartEncoding\": true \n },\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.useinsider.com/v1/sendMultipleMessage","description":"This API enables you to send targeted transactional SMS to your users. You can trigger these SMS messages once a user takes a specific action on your platform.
\nYou can use transactional SMS messages to:
\nSend a post-purchase SMS to share details about a purchase/booking,
\nHelp your users reset their password if they forget it,
\nConfirm an order a user places,
\nShare delivery tracking details of a purchase (when it is shipped, on the way, and delivered) and take many other actions.
\nYou can send transactional SMS messages for:
\nSystem notifications
\nOrder confirmation/information
\nThank you for your purchase! Your order number is {orderNumber}. View more information about your order here: {Link}
\nHey, {firstName}! Thanks for your purchase! View more information about your order ({orderNumber}) here: {Link}
\nShipping Confirmation
\nGreat news, {firstName}! Your order ({orderNumber}) has shipped and will arrive soon. Click here to view your order details: {Link}
\nGet excited! Your order ({orderNumber}) has shipped and is on its way to you. Click here to view your order details: {Link}
\nTicket booking confirmation or cancellation
\nInformation about shipping and delivery updates
\nRecurring billing / Payment Updates
\nAppointment confirmations
\nWelcome Messages
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your SMS content.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\n{\n \"messages\": [\n {\n \"phoneNumber\": \"+905555555555\",\n \"content\": \"This is SMS body.\",\n \"callback\": \"http://callback.url\",\n \"settings\": {\n \"urlShorteningDomain\": \"insdr.io\",\n \"urlShorteningStatus\": true,\n \"urlTrackingStatus\": true\n },\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n },\n {\n \"phoneNumber\": \"90 (555) 55\",\n \"content\": \"This is SMS body.\",\n \"callback\": \"http://callback.url\",\n \"settings\": {\n \"urlShorteningDomain\": \"insdr.io\",\n \"urlShorteningStatus\": true,\n \"urlTrackingStatus\": true\n },\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n }\n ]\n}\n{\n \"message\": \"Accepted\",\n \"messageIds\": [\n {\n \"phoneNumber\": \"+905555555555\",\n \"messageSid\": \"sms-a1234567-b123-c123-d123-e123f123456\"\n }\n ],\n \"errors\": [\n {\n \"field\": \"messages[1].phoneNumber\",\n \"error\": \"This field must be a valid phone number.\"\n }\n ]\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"sent\",\n \"partCount\": 1\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"delivered\"\n}\n\n{\n \"id\": \"sms-a1234567-b123-c123-d123-e123f123456\",\n \"uniqueArgs\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"event\": \"undelivered\",\n \"reason\": {\n \"message\": \"Soft Bounce\",\n \"code\": 1404\n }\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nTransactional API cannot be used to send promotional SMS. It is designed to set transactional SMS only.
\nThe phone number should be in E164 format.
\nContent can’t be empty. The maximum limit is 670 characters.
\nThe rate limit is 5 requests per second.
\nThe message limit is 50 messages per request.
\nThe maximum speed will be determined based on the Provider Setup.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"sms\",\n \"brandName\": \"YourBrand\"\n}"},"url":"https://verify.useinsider.com/v1/channel/create","description":"The Verify API enables you to generate, send, and verify OTP codes for the SMS channel. You can utilize this API to generate OTP codes as defined in the payloads. Integrating it into your own websites or apps, you can trigger it on login pages, payment pages, and more.
\nIn this regard, in order to send OTP codes, you must create a channel for your brand just once. Creating a channel, you will have predefined templates for 10 languages by default.
\nTo be able to use the Verify API:
\nBoth SMS & Transactional SMS Products should be enabled in Insider's InOne Panel.
\nSMS Integration should be finalized and you should be able to receive a test message from the Insider's InOnePanel.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'https://verify.useinsider.com/v1/channel/create' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"sms\",\n \"brandName\": \"YourBrandName\"\n}'\n\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"this field must be one of these:sms\",\n \"field\": \"channel\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"channel already exists\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can only create OTP for SMS channel.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"sms\",\n \"brandName\": \"YOURBRAND\"\n}"},"url":"https://verify.useinsider.com/v1/channel/update","description":"The Verify API enables you to generate, send, and verify OTP codes for the SMS channel. You can utilize this API to generate OTP codes as defined in the payloads. Integrating it into your own websites or apps, you can trigger it on login pages, payment pages, and more.
\nAfter you create a channel for your brand, you can edit and update it later.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/channel/update' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"sms\",\n \"brandName\": \"YourBrand\"\n}'\n\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"this field must be one of these:sms\",\n \"field\": \"channel\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"channel already exists\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can only create OTP for SMS channel.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"url":"https://verify.useinsider.com/v1/channel/list","description":"The Verify API enables you to generate, send, and verify OTP codes for the SMS channel.
\nAfter you create a channel for your brand, you can list its templates later.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/template/list' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************'\n\nThis response indicates that your request was successfully completed.
\n{\n \"templates\": {\n \"sms\": [\n {\n \"locale\": \"de\",\n \"text\": \"Ihr {brandName} Bestätigungscode lautet: {code}\"\n },\n {\n \"locale\": \"en\",\n \"text\": \"Your {brandName} verification code is: {code}\"\n },\n {\n \"locale\": \"es\",\n \"text\": \"Su código de verificación de {brandName} es: {code}\"\n },\n {\n \"locale\": \"fr\",\n \"text\": \"Votre code de vérification {brandName} est: {code}\"\n },\n {\n \"locale\": \"it\",\n \"text\": \"Il tuo codice di verifica {brandName} è: {code}\"\n },\n {\n \"locale\": \"ja\",\n \"text\": \"あなたの{brandName}確認コードは: {code}です\"\n },\n {\n \"locale\": \"nl\",\n \"text\": \"Uw {brandName} verificatiecode is: {code}\"\n },\n {\n \"locale\": \"pt\",\n \"text\": \"Seu código de verificação {brandName} é: {code}\"\n },\n {\n \"locale\": \"ru\",\n \"text\": \"Ваш проверочный код {brandName}: {code}\"\n },\n {\n \"locale\": \"tr\",\n \"text\": \"{brandName} doğrulama kodunuz: {code}\"\n }\n ]\n }\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can only create OTP for SMS channel.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"sms\",\n \"locale\": \"en\",\n \"text\": \"Your {brandName} verification code is: {code}\"\n}"},"url":"https://verify.useinsider.com/v1/channel/update","description":"The Verify API enables you to generate, send, and verify OTP codes for the SMS channel.
\nAfter you create a channel for your brand, you can edit and update its templates later.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/template/update' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"sms\",\n \"locale\": \"en\",\n \"text\": \"Your {brandName} verification code is: {code}\"\n}'\n\nThis response indicates that your request was successfully completed.
\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"this field is required\",\n \"field\": \"text\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"no changes detected\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can only create OTP for SMS channel.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"sms\",\n \"to\": \"+905XXXXXXXXX\"\n}"},"url":"https://verify.useinsider.com/v1/channel/generate","description":"The Verify API enables you to generate, send, and verify OTP codes for the SMS channel. You can utilize this API to generate OTP codes as defined in the payloads. Integrating it into your own websites or apps, you can trigger it on login pages, payment pages, and more.
\nAfter you create your channel for your brand and update the templates, you need to perform the generate action for your OTP.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'https://verify.useinsider.com/v1/generate' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"sms\",\n \"to\": \"+905XXXXXXXXX\"\n}'\n\nThis response indicates that your request was successfully completed.
\n{\n \"channel\": \"sms\",\n \"dateCreated\": \"2023-07-28T14:40:41Z\",\n \"dateUpdated\": \"2023-07-28T14:40:41Z\",\n \"locale\": \"en\",\n \"maxAttempts\": 3,\n \"ttl\": 180\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"channel information must be a valid phone number for sms\",\n \"field\": \"to\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can only create OTP for SMS channel.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"+905XXXXXXXXX\",\n \"code\": 1234\n}"},"url":"https://verify.useinsider.com/v1/check","description":"The Verify API enables you to generate, send, and verify OTP codes for the SMS channel. You can utilize this API to generate OTP codes as defined in the payloads. Integrating it into your own websites or apps, you can trigger it on login pages, payment pages, and more.
\nAfter you create your channel for your brand and update the templates, you need to perform the verify action for your OTP.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/check' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************' \\\n--data \n \"to\": \"+905XXXXXXXXX\",\n \"code\": 1234\n}'\n\nThis response indicates that your request was successfully completed.
\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid code\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"code not found\",\n \"field\": \"code\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"maximum attempts exceeded\",\n \"field\": \"code\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can only create OTP for SMS channel.
\nWith this API, you can send targeted transactional SMS to your users.
\n","_postman_id":"507c8912-2010-4fdd-b71b-f674c148493a"},{"name":"WhatsApp APIs","item":[{"name":"Transactional API","item":[{"name":"Send transactional WhatsApp template message","id":"68b1b6d8-f6c9-41a6-b539-fb1c9f108b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"INS.tink5Fi************.UZsBeR8**************************0rXedDKWc5YE","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{TEMPLATE_LANGUAGE_CODE}}\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{PARAMETER_VALUE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"1\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"2\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/send","description":"Transactional WhatsApp API enables you to send targeted transactional WhatsApp messages to your users. You can trigger these WhatsApp messages once a user takes a specific action on your platform.
\nNote: Meta doesn't support adding emojis on button ID.
\nThe following is a sample body to send transactional WhatsApp messages.
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.*****************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{TEMPLATE_LANGUAGE_CODE}}\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{PARAMETER_VALUE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"1\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"2\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nIf you want to use CTA (Call To Action), you can use the below sample request:
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'x-ins-auth-key: INS.kjQu-+bL4HpeZqvgr1j0.d4IVgHl9GcE+_eaKxNA3P8M3q8-emrO3-zalg9GSF29mK+Jz5k' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+994558964184\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"mert_masterfile_media_with_button\",\n \"language\": {\n \"code\": \"en\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://inshoppingcart.com/seleniumautomation/wp-content/uploads/2018/08/cap-2.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"https://vikingsankara.com?abc=sha\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"https://vikingsankara.com\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nIf you don't want to use CTA, you can use the below sample request:
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.tiNlcL284J8dwCpfoqdR.gpyLwFG-0fSHPS9+kZYNsI-D2IWFNjlaRDlXJrZjx2_ZPTP37I' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+994558964184\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"7_image_header_no_button_copy\",\n \"language\": {\n \"code\": \"fi\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://image.useinsider.com/vikingsankara/media/whatsapp-business/11521/83rbBaWO7H63VmACSXiZ1716506118.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"shahla\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nIf you use the wrong key, you will see the following error.
\n{\n \"message\": \"unauthorized\"\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nTransactional API cannot be used for sending bulk/promotional WhatsApp messages. It is designed only to set transactional WhatsApp messages.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": true,\n \"body\": \"Example Message\"\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/send","description":"This API enables you to send targeted transactional WhatsApp messages to your users. You can send only text content in this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**********************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": true,\n \"body\": \"Example Message\"\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nIf you use the wrong key, you will see the following error.
\n{\n \"message\": \"unauthorized\"\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nTransactional API cannot be used for sending bulk/promotional WhatsApp messages. It is designed only to set transactional WhatsApp messages.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"{{IMAGE_URL}}\",\n \"caption\": \"Media Message (Image)\"\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/send","description":"This API enables you to send targeted transactional WhatsApp messages to your users. You can send media and text content in this message type
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nIf you use the wrong key, you will see the following error.
\n{\n \"message\": \"unauthorized\"\n}\n\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"document\",\n \"audio\": {\n \"link\": \"{{DOCUMENT_LINK}}\",\n \"caption\": \"{{DOCUMENT_DESCRIPTION}}\",\n \"filename\": \"{{DOCUMENT_NAME}}\"\n\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/send","description":"This API enables you to send targeted transactional WhatsApp messages to your users. You can send only document content in this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\nIf you use the wrong key, you will see the following error.
\n{\n \"message\": \"unauthorized\"\n}\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"location\",\n \"location\": {\n \"longitude\": \"11.1111111\",\n \"latitude\": \"11.1111111\",\n \"name\": \"{{ADDRESS_NAME}}\",\n \"address\": \"{{FULL_ADDRESS}}\"\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/send","description":"This API enables you to send targeted transactional WhatsApp messages to your users. You can send media and text content in this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\nIf you use the wrong key, you will see the following error.
\n{\n \"message\": \"unauthorized\"\n}\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"button\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"HEADER_TEXT\"\n },\n \"body\": {\n \"text\": \"BUTTON_TEXT\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"UNIQUE_BUTTON_ID_1\",\n \"title\": \"BUTTON_TITLE_1\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"UNIQUE_BUTTON_ID_2\",\n \"title\": \"BUTTON_TITLE_2\"\n }\n }\n ]\n }\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/send","description":"This API enables you to send targeted transactional WhatsApp messages to your users. You can send media and text content in this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\nIf you use the wrong key, you will see the following error.
\n{\n \"message\": \"unauthorized\"\n}\nWhatsApp Transactional API v2 is a REST API that enables your systems to send transactional messages through the WhatsApp Business Platform.
\nNote: To send transactional WhatsApp messages using OAuth 2.0, you must first generate an OAuth 2.0 credential. For step-by-step instructions, refer to OAuth 2.0 Credentials.
\nNote: Before sending Transactional WhatsApp template messages, make sure you create your template in InOne first. Refer to Create a WhatsApp Business Standard Template on InOne for step-by-step guidance.
\nRefer to the visual below for an example of how a transactional WhatsApp template message is displayed.
\n![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/image-4HMMKA9C.png\")
\n\n{\n \"from\": \"+905551234567\",\n \"messages\": [{\n \"phone_number\": \"+905559876543\",\n \"user_id\": \"user-uuid-123\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"welcome_message\",\n \"language\": {\n \"code\": \"tr\"\n },\n \"components\": [{\n \"type\": \"body\",\n \"parameters\": [{\n \"type\": \"text\",\n \"text\": \"Ahmet\"\n }]\n }]\n }\n }\n }]\n}\n\nEach element in the messages array contains:
Used to send template messages. Templates must be pre-created and approved in the Meta Business Manager.
\nTemplates can include the following component types:
\nThe header component corresponds to the template's header section.
\n{\n \"type\": \"header\",\n \"parameters\": [{\n \"type\": \"text\",\n \"text\": \"Değişken başlık değeri\"\n }]\n} \n\nTo use a media header, you can use the request below.
\n{\n \"type\": \"header\",\n \"parameters\": [{\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://example.com/image.jpg\"\n }\n }]\n}\n\n\n\nHeader parameter types can be text, image, video and document.
\n
Body component is the main text section of the template.
\n{\n \"type\": \"body\",\n \"parameters\": [{\n \"type\": \"text\",\n \"text\": \"Ahmet Yılmaz\"\n }, {\n \"type\": \"text\",\n \"text\": \"12345\"\n }]\n}\n\nThe main text section of the template.
\n{\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [{\n \"type\": \"text\",\n \"text\": \"PROMO2024\"\n }]\n}\n\nTo add buttons to the template, use the request below.
\n{\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [{\n \"type\": \"text\",\n \"text\": \"PROMO2024\"\n }]\n}\n\nTo add CTA (Call-to-Action) links to your template, use the request below.
\n{\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [{\n \"type\": \"text\",\n \"cta_link\": \"?code=SUMMER2024\"\n }]\n}\n\n\n\nButton sub_types are url and quick_reply.
\n
Carousel template (product catalog cards).
\n{\n \"type\": \"carousel\",\n \"cards\": [\n {\n \"card_index\": 0,\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://example.com/product1.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Ürün 1 Adı\"\n },\n {\n \"type\": \"text\",\n \"text\": \"999.99 TL\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"product-1-slug\"\n }\n ]\n }\n ]\n },\n {\n \"card_index\": 1,\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://example.com/product2.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Ürün 2 Adı\"\n },\n {\n \"type\": \"text\",\n \"text\": \"1299.99 TL\"\n }\n ]\n }\n ]\n }\n ]\n}\n\n\n\nCarousel template can contain a maximum of 10 cards (card_index: 0-9).
\n
{\n \"type\": \"limited_time_offer\",\n \"parameters\": [\n {\n \"type\": \"limited_time_offer\",\n \"limited_time_offer\": {\n \"expiration_time_ms\": 1640000000000\n }\n }\n ]\n}\n\n{\n \"type\": \"button\",\n \"sub_type\": \"copy_code\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"coupon_code\",\n \"coupon_code\": \"SUMMER2024\"\n }\n ]\n}\n\n{\n \"type\": \"button\",\n \"sub_type\": \"flow\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"action\",\n \"action\": {\n \"flow_token\": \"unique-flow-token\",\n \"flow_action_data\": {\n \"user_id\": \"12345\",\n \"product_id\": \"SKU-123\"\n }\n }\n }\n ]\n}\n\nUsed to send plain text messages (typically for conversational use).
\n{\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Merhaba! Siparişiniz hazırlanıyor.\",\n \"preview_url\": false\n }\n}\n\nUsed to send images.
\n{\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://example.com/image.jpg\",\n \"caption\": \"Product Image\"\n }\n}\n\n{\n \"type\": \"image\",\n \"image\": {\n \"id\": \"1234567890\",\n \"caption\": \"Uploaded Image\"\n }\n}\n\n\n\nSupported formats for image messages are JPEG, PNG. The maximum size is 5 MB.
\n
Used to send videos.
\n{\n \"type\": \"video\",\n \"video\": {\n \"link\": \"https://example.com/video.mp4\",\n \"caption\": \"Product video\"\n }\n}\n\n\n\nSupported formats for video messages are MP4 and 3GPP. The maximum size is 16 MB.
\n
Used to send documents/files.
\n{\n \"type\": \"document\",\n \"document\": {\n \"link\": \"https://example.com/invoice.pdf\",\n \"filename\": \"Fatura-12345.pdf\",\n \"caption\": \"Sipariş faturanız\"\n }\n}\n\n\n\nSupported formats for document messages are PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT and CSV. The maximum size is 100 MB.
\n
Used to send audio files.
\n{\n \"type\": \"audio\",\n \"audio\": {\n \"link\": \"https://example.com/audio.mp3\"\n }\n}\n\n\n\nSupported formats for audio messages are AAC, M4A, AMR, MP3 and OGG OPUS. The maximum size is 16 MB.
\n
Used to send location/map coordinates.
\n{\n \"type\": \"location\",\n \"location\": {\n \"latitude\": \"41.0082\",\n \"longitude\": \"28.9784\",\n \"name\": \"İstanbul\",\n \"address\": \"İstanbul, Türkiye\"\n }\n}\n\nUsed to send stickers.
\n{\n \"type\": \"sticker\",\n \"sticker\": {\n \"link\": \"https://example.com/sticker.webp\"\n }\n}\n\n\n\nSupported format for sticker messages is WebP (static or animated) The maximum size is 100 KB (static), 500 KB (animated).
\n
Used to send interactive messages (buttons, lists, products, flows).
\n{\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Başlık metni\"\n }\n}\n\n{\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://example.com/header.jpg\"\n }\n }\n}\n\n\n\nHeader types can be text, image, video, document.
\n
{\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"btn_yes\",\n \"title\": \"Evet\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"btn_no\",\n \"title\": \"Hayır\"\n }\n }\n ]\n }\n}\n\n\n\nButton title can be a maximum 20 characters.
\n
{\n \"action\": {\n \"button\": \"Seçenekleri Gör\",\n \"sections\": [\n {\n \"title\": \"Kategori 1\",\n \"rows\": [\n {\n \"id\": \"row_1\",\n \"title\": \"Seçenek 1\",\n \"description\": \"Seçenek açıklaması\"\n },\n {\n \"id\": \"row_2\",\n \"title\": \"Seçenek 2\",\n \"description\": \"Diğer seçenek\"\n }\n ]\n }\n ]\n }\n}\n\n{\n \"action\": {\n \"catalog_id\": \"123456789\",\n \"product_retailer_id\": \"SKU-12345\"\n }\n}\n\n{ \"action\": { \"catalog_id\": \"123456789\", \"sections\": [ { \"title\": \"Öne Çıkan Ürünler\", \"product_items\": [ { \"product_retailer_id\": \"SKU-001\" }, { \"product_retailer_id\": \"SKU-002\" } ] } ] }}JSONCopy
\n{ \"action\": { \"name\": \"flow\", \"parameters\": { \"flow_message_version\": \"3\", \"flow_token\": \"unique-token\", \"flow_id\": \"123456789\", \"flow_cta\": \"Form Doldur\", \"flow_action\": \"navigate\", \"flow_action_payload\": { \"screen\": \"FORM_SCREEN\", \"data\": { \"user_id\": \"12345\" } } } }}JSONCopy
\n{ \"action\": { \"name\": \"cta_url\", \"parameters\": { \"display_text\": \"Web Siteyi Ziyaret Et\", \"url\": \"https://example.com\" } }}JSONCopy
\n{ \"action\": { \"name\": \"catalog_message\", \"parameters\": { \"thumbnail_product_retailer_id\": \"SKU-FEATURED\" } }}JSONCopy
\n{ \"action\": { \"cards\": [ { \"card_index\": 0, \"type\": \"carousel\", \"header\": { \"type\": \"image\", \"image\": { \"link\": \"https://example.com/product1.jpg\" } }, \"body\": { \"text\": \"Ürün 1 - 999 TL\" }, \"action\": { \"name\": \"cta_url\", \"parameters\": { \"display_text\": \"Satın Al\", \"url\": \"https://example.com/product/1\" } } } ] }}JSONCopy
\nUsed to reply to a specific message.
\n![https://example.com/product1.jpg\"](\"https://example.com/product1.jpg\"){kind=link}
{\n \"type\": \"text\",\n \"context\": {\n \"message_id\": \"wamid.HBgLOTA5NTU1MTIzNDU2NxUCABIYIDNBMzQwRjg2...\"\n },\n \"text\": {\n \"body\": \"Teşekkür ederiz!\"\n }\n}\n\n{\n \"keys\": [\n \"whatsapp-550e8400-e29b-41d4-a716-446655440000\"\n ]\n}\n\n{\n \"message\": \"Failed to validate request.\",\n \"error\": {\n \"message\": \"Failed to validate request.\",\n \"code\": \"2001\"\n }\n}\n\n{\n \"message\": \"Failed to validate request.\",\n \"error\": {\n \"message\": \"Failed to validate request.\",\n \"code\": \"2002\"\n }\n}\n\n{\n \"message\": \"Message could not be sent.\",\n \"detail\": \"There is no active provider.\",\n \"error\": {\n \"message\": \"Message could not be sent.\",\n \"code\": \"2003\"\n }\n}\n\nRequired. Sender’s WhatsApp phone number (in E.164 format)
\n","type":"text/plain"},"key":"from","value":null},{"disabled":true,"description":{"content":"List of messages to be sent (minimum 1 message)
\n","type":"text/plain"},"key":"messages","value":null},{"disabled":true,"description":{"content":"URL shortening settings
\n","type":"text/plain"},"key":"url_shortener_config","value":null},{"disabled":true,"description":{"content":"Enable/disable URL shortening
\n","type":"text/plain"},"key":"url_shortener_config.status","value":null},{"disabled":true,"description":{"content":"Domain name for shortening
\n","type":"text/plain"},"key":"url_shortener_config.domain","value":null},{"disabled":true,"description":{"content":"Custom parameters (key–value map)
\n","type":"text/plain"},"key":"unique_args","value":null},{"disabled":true,"description":{"content":"Remove tracking parameters
\n","type":"text/plain"},"key":"remove_tracking_params","value":null}],"variable":[]}},"response":[],"_postman_id":"cf8b4ddb-b193-4aaa-8b7b-f0c96789708d"},{"name":"Update Transactional WhatsApp Webhook Settings with OAuth 2.0","id":"ac7181d7-a787-4da1-8e6d-f05de52c2751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://gw.useinsider.com/api/wa/v2/transactional/settings","description":"You can use this API to update webhooks and other settings for transactional WhatsApp messages.
\n\n\n<p >The system supports two grant types for OAuth2 authentication:</p>
\n
client_credentials
refresh_token
curl -X POST \"https://gw.useinsider.com/api/wa/v2/transactional/settings\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer your_access_token\" \\\n -d '{\n \"webhook_url\": \"https://partner.example.com/webhooks/transactional\",\n \"from\": \"+1234567890\",\n \"auth_type\": \"oauth2\",\n \"oauth2\": {\n \"grant_type\": \"client_credentials\",\n \"token_url\": \"https://oauth.partner.com/oauth/token\",\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"scopes\": [\n \"webhook.write\"\n ],\n \"expires_in\": 3600\n }\n }'\n\ncurl -X POST \"https://gw.useinsider.com/api/wa/v2/transactional/settings\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer your_access_token\" \\\n -d '{\n \"webhook_url\": \"https://partner.example.com/webhooks/transactional\",\n \"from\": \"+1234567890\",\n \"auth_type\": \"oauth2\",\n \"oauth2\": {\n \"grant_type\": \"refresh_token\",\n \"token_url\": \"https://oauth.partner.com/oauth/token\",\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"refresh_token\": \"your_refresh_token\",\n \"scopes\": [\n \"webhook.write\"\n ],\n \"expires_in\": 3600\n }\n }'\n\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{TEMPLATE_LANGUAGE_CODE}}\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{PARAMETER_VALUE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"1\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"2\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}"},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. To create a conversational flow, one of the ways is to integrate a bot to reply to users' WhatsApp messages.
\nThe Conversational API is designed for WhatsApp Bot connection.
\nYou can use the below sample request if you want to use the quick reply buttons:
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************************' \\\n--data '{\n \"from\": \"{{PHONE_NUMBER}}\", //Example: +112312312\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{TEMPLATE_LANGUAGE_CODE}}\",\n \"policy\": \"deterministic\",\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{PARAMETER_VALUE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"1\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"2\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nIf you want to use CTA (Call To Action), you can use the below sample request:
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'x-ins-auth-key: INS.kjQu-+bL4HpeZqvgr1j0.d4IVgHl9GcE+_eaKxNA3P8M3q8-emrO3-zalg9GSF29mK+Jz5k' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+994558964184\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"mert_masterfile_media_with_button\",\n \"language\": {\n \"code\": \"en\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://inshoppingcart.com/seleniumautomation/wp-content/uploads/2018/08/cap-2.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"https://vikingsankara.com?abc=sha\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"https://vikingsankara.com\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nIf you don't want to use CTA, you can use the below sample request:
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.tiNlcL284J8dwCpfoqdR.gpyLwFG-0fSHPS9+kZYNsI-D2IWFNjlaRDlXJrZjx2_ZPTP37I' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+994558964184\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"7_image_header_no_button_copy\",\n \"language\": {\n \"code\": \"fi\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://image.useinsider.com/vikingsankara/media/whatsapp-business/11521/83rbBaWO7H63VmACSXiZ1716506118.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"shahla\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"from\": \"{{FROM}}\",\n \"messages\": [\n {\n \"phoneNumber\": \"{{TO}}\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{LANG_CODE}}\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{BODY_1}}\"\n }\n ]\n },\n {\n \"type\": \"carousel\",\n \"cards\": [\n {\n \"card_index\": 0,\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"{{IMG_ID_1}}\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{CARD_TEXT_1}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"{{PAYLOAD_1}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{URL_1}}\"\n }\n ]\n }\n ]\n },\n {\n \"card_index\": 1,\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"{{IMG_ID_2}}\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{CARD_TEXT_2}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"{{PAYLOAD_2}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{URL_2}}\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. To create a conversational flow, one of the ways is to integrate a bot to reply to users' WhatsApp messages.
\nThe Conversational API is designed for connection with WhatsApp bots.
\nWhen creating a new template in either marketing or utility categories, you can select the Carousel template type. This feature enables the creation of multi-card messages, with each card displaying unique content, images, and interactive buttons. Carousel templates offer an engaging way to showcase multiple options or pieces of information within a single message, making it easier to capture user attention and encourage interaction.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************************' \\\n--data '{\n \"from\": \"{{FROM}}\",\n \"messages\": [\n {\n \"phoneNumber\": \"{{TO}}\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{LANG_CODE}}\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{BODY_1}}\"\n }\n ]\n },\n {\n \"type\": \"carousel\",\n \"cards\": [\n {\n \"card_index\": 0,\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"{{IMG_ID_1}}\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{CARD_TEXT_1}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"{{PAYLOAD_1}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{URL_1}}\"\n }\n ]\n }\n ]\n },\n {\n \"card_index\": 1,\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"id\": \"{{IMG_ID_2}}\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{CARD_TEXT_2}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"{{PAYLOAD_2}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{URL_2}}\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}\n'\n\nYou can use the below sample request if you want to use the quick reply buttons:
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************************' \\\n--data '{\n \"from\": \"{{PHONE_NUMBER}}\", //Example: +112312312\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"{{TEMPLATE_LANGUAGE_CODE}}\",\n \"policy\": \"deterministic\",\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{PARAMETER_VALUE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"1\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"2\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nIf you want to use CTA (Call To Action), you can use the below sample request:
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'x-ins-auth-key: INS.kjQu-+bL4HpeZqvgr1j0.d4IVgHl9GcE+_eaKxNA3P8M3q8-emrO3-zalg9GSF29mK+Jz5k' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+994558964184\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"mert_masterfile_media_with_button\",\n \"language\": {\n \"code\": \"en\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://inshoppingcart.com/seleniumautomation/wp-content/uploads/2018/08/cap-2.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"https://vikingsankara.com?abc=sha\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"https://vikingsankara.com\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nIf you don't want to use CTA, you can use the below sample request:
\ncurl --location 'https://whatsapp.useinsider.com/v1/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.tiNlcL284J8dwCpfoqdR.gpyLwFG-0fSHPS9+kZYNsI-D2IWFNjlaRDlXJrZjx2_ZPTP37I' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+994558964184\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"7_image_header_no_button_copy\",\n \"language\": {\n \"code\": \"fi\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://image.useinsider.com/vikingsankara/media/whatsapp-business/11521/83rbBaWO7H63VmACSXiZ1716506118.jpg\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"sub_type\": \"\",\n \"index\": \"\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"shahla\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nEach card in the carousel template must include at least one button.
\nAll cards should have buttons of the same type and quantity.
\nThe template supports a minimum of 2 cards and a maximum of 6 cards per message.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": true,\n \"body\": \"Example Message\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. One way to create a conversational flow is to integrate a bot to reply to users' WhatsApp messages.
\nYou can only send text content using this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": true,\n \"body\": \"Example Message\"\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"{{PHONE_NUMBER}}\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{OTP_TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"en\",\n \"policy\": \"deterministic\",\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{OTP_CODE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{OTP_CODE}}\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. One way to create a conversational flow is to integrate a bot to reply to users' WhatsApp messages.
\nTo use an OTP template, you must have your own OTP system. Then, you must create the OTP template from the Meta system.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'x-ins-auth-key: INS.**************' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"{{PHONE_NUMBER}}\",\n \"message\": {\n \"type\": \"template\",\n \"template\": {\n \"name\": \"{{OTP_TEMPLATE_NAME}}\",\n \"language\": {\n \"code\": \"en\",\n \"policy\": \"deterministic\",\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{OTP_CODE}}\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"{{OTP_CODE}}\"\n }\n ]\n }\n ]\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"{{IMAGE_URL}}\",\n \"caption\": \"Media Message (Image)\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. One way to create a conversational flow is to integrate a bot to reply to users' WhatsApp messages.
\nYou can send media and text content using this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"{{IMAGE_URL}}\",\n \"caption\": \"Media Message (Image)\"\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"document\",\n \"audio\": {\n \"link\": \"{{DOCUMENT_LINK}}\",\n \"caption\": \"{{DOCUMENT_DESCRIPTION}}\",\n \"filename\": \"{{DOCUMENT_NAME}}\"\n\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. To create a conversational flow, one of the ways is to integrate a bot to reply to users' WhatsApp messages.
\nYou can send only document content in this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"document\",\n \"audio\": {\n \"link\": \"{{DOCUMENT_LINK}}\",\n \"caption\": \"{{DOCUMENT_DESCRIPTION}}\",\n \"filename\": \"{{DOCUMENT_NAME}}\"\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will be returned in the response.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"location\",\n \"location\": {\n \"longitude\": \"11.1111111\",\n \"latitude\": \"11.1111111\",\n \"name\": \"{{ADDRESS_NAME}}\",\n \"address\": \"{{FULL_ADDRESS}}\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. To create a conversational flow, one of the ways is to integrate a bot to reply to users' WhatsApp messages.
\nYou can send media and text content in this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"location\",\n \"location\": {\n \"longitude\": \"11.1111111\",\n \"latitude\": \"11.1111111\",\n \"name\": \"{{ADDRESS_NAME}}\",\n \"address\": \"{{FULL_ADDRESS}}\"\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"button\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"HEADER_TEXT\"\n },\n \"body\": {\n \"text\": \"BUTTON_TEXT\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"UNIQUE_BUTTON_ID_1\",\n \"title\": \"BUTTON_TITLE_1\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"UNIQUE_BUTTON_ID_2\",\n \"title\": \"BUTTON_TITLE_2\"\n }\n }\n ]\n }\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://whatsapp.useinsider.com/v1/conversational/send","description":"The WhatsApp Marketing product provides conversational messages, allowing users to initiate conversations with businesses after the business has sent an initial message. One way to create a conversational flow is to integrate a bot to reply to users' WhatsApp messages.
\nYou can send media and text content using this message type.
\nYou can send this message type if the user has sent a message to your number in the last 24 hours.
\ncurl --location 'https://whatsapp.useinsider.com/v1/conversational/send' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.**************************' \\\n--data '{\n \"messages\": [\n {\n \"phoneNumber\": \"+1**********\",\n \"message\": {\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"button\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"HEADER_TEXT\"\n },\n \"body\": {\n \"text\": \"BUTTON_TEXT\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"UNIQUE_BUTTON_ID_1\",\n \"title\": \"BUTTON_TITLE_1\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"UNIQUE_BUTTON_ID_2\",\n \"title\": \"BUTTON_TITLE_2\"\n }\n }\n ]\n }\n }\n }\n }\n ]\n}'\n\nOne key information will be returned for each message to be sent. This key will be added to all events related to the message.
\n{\n \"keys\": [\n \"whatsapp-*************************\"\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nOnly new WhatsApp messages can be sent via this API. No data can be retrieved.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe rate limit is 10 requests per second.
\nWhatsApp Transactional API v2 is a REST API that enables your systems to send conversational messages through the WhatsApp Business Platform.
\n\n\n
To send conversational WhatsApp messages using OAuth 2.0, you must first generate an OAuth 2.0 credential. For step-by-step instructions, refer to OAuth 2.0 Credentials.
\n\n\n
Before sending Conversational WhatsApp template messages, make sure you create your template in InOne first. Refer to Create a WhatsApp Business Standard Template on InOne for step-by-step guidance.
\nRefer to the visual below for an example of how a conversational WhatsApp template message is displayed.
\n\n\nUse the request below to send conversational messages via WhatsApp. In addition to templates, message types such as text and media can be sent.
\n{\n \"from\": \"+111111111\",\n \"messages\": [\n {\n \"phone_number\": \"+1234567890\",\n \"user_id\": \"user-uuid-123\",\n \"message\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello! How can I help you?\",\n \"preview_url\": false\n }\n }\n }\n ]\n}\n\nThis endpoint shares the same parameters as the Transactional WhatsApp Messages with OAuth 2.0. The primary distinction is that conversational message types, such as text, image, video, document, audio, location, and interactive, are available for the message.type field.
This code indicates that the request has been completed.
\n{\n \"keys\": [\n \"whatsapp-660e8400-e29b-41d4-a716-446655440001\"]\n}\n\nThese endpoints return the same error codes as the Transactional WhatsApp Messages with OAuth 2.0 (2001, 2002, 2003).
\nRequired. Sender’s WhatsApp phone number (in E.164 format)
\n","type":"text/plain"},"key":"from","value":null},{"disabled":true,"description":{"content":"List of messages to be sent (minimum 1 message)
\n","type":"text/plain"},"key":"messages","value":null},{"disabled":true,"description":{"content":"URL shortening settings
\n","type":"text/plain"},"key":"url_shortener_config","value":null},{"disabled":true,"description":{"content":"Enable/disable URL shortening
\n","type":"text/plain"},"key":"url_shortener_config.status","value":null},{"disabled":true,"description":{"content":"Domain name for shortening
\n","type":"text/plain"},"key":"url_shortener_config.domain","value":null},{"disabled":true,"description":{"content":"Custom parameters (key–value map)
\n","type":"text/plain"},"key":"unique_args","value":null},{"disabled":true,"description":{"content":"Remove tracking parameters
\n","type":"text/plain"},"key":"remove_tracking_params","value":null}],"variable":[]}},"response":[],"_postman_id":"cea9d131-42d5-4abb-b9be-833a64e90c65"},{"name":"Update Conversational WhatsApp Webhook Settings with OAuth 2.0","id":"61ac4b66-fde2-4c49-aa61-71df8f818fd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://gw.useinsider.com/api/wa/v2/conversational/settings","description":"This endpoint helps you update the webhook URL and other relevant settings for conversational messages.
\nThe system supports two grant types for OAuth2 authentication:
\ngrant_type: client_credentials
grant_type: refresh_token
curl -X POST \"https://gw.useinsider.com/api/wa/v2/conversational/settings\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer your_access_token\" \\\n -d '{\n \"webhook_url\": \"https://partner.example.com/webhooks/conversational\",\n \"from\": \"+1234567890\",\n \"auth_type\": \"oauth2\",\n \"oauth2\": {\n \"grant_type\": \"client_credentials\",\n \"token_url\": \"https://oauth.partner.com/oauth/token\",\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"scopes\": [\n \"webhook.write\"\n ],\n \"expires_in\": 3600\n }\n }'\n\ncurl -X POST \"https://gw.useinsider.com/api/wa/v2/conversational/settings\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer your_access_token\" \\\n -d '{\n \"webhook_url\": \"https://partner.example.com/webhooks/conversational\",\n \"from\": \"+1234567890\",\n \"auth_type\": \"oauth2\",\n \"oauth2\": {\n \"grant_type\": \"refresh_token\",\n \"token_url\": \"https://oauth.partner.com/oauth/token\",\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"refresh_token\": \"your_refresh_token\",\n \"scopes\": [\n \"webhook.write\"\n ],\n \"expires_in\": 3600\n }\n }'\n\nThe WhatsApp Marketing tool enables interactive messaging, allowing users to engage with businesses after the initial message. To ensure a seamless experience, businesses can integrate a bot to respond to WhatsApp messages. WhatsApp Conversational further enhances this by offering powerful two-way conversational messaging focused on end-to-end shopping experiences.
\nBrands and retailers can use templates like product catalogs for browsing, category lists for product discovery, and detailed description cards for completing purchases, providing a comprehensive and engaging shopping experience through WhatsApp.
\n![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/capislide.png\")
\n\nYou can refer to the image below to better understand how the system works:
\n![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/api-call.png\")
","_postman_id":"6e96d4ae-cd24-42fe-ae55-5d3c2d410f0c"},{"name":"OTP for WhatsApp","item":[{"name":"Create a channel","id":"eb65bec0-0cb5-4d5a-9185-57c3b3ed3939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"INS.**************************","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"whatsapp\"\n}"},"url":"https://verify.useinsider.com/v1/channel/create","description":"The Verify API enables you to generate, send, and verify OTP codes for the WhatsApp channel. In this regard, to send OTP codes, you must create a channel for your brand for once.
\nThis API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'https://verify.useinsider.com/v1/channel/create' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"whatsapp\"\n}'\n\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"this field must be one of these:whatsapp\",\n \"field\": \"channel\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"channel already exists\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe service is subject to a rate limit of 100 requests per second to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"whatsapp\",\n \"locale\": \"tr\",\n \"templateName\": \"otp_template\"\n}","options":{"raw":{"language":"json"}}},"url":"https://verify.useinsider.com/v1/template/create","description":"The Verify API enables you to generate, send, and verify OTP codes for the WhatsApp channel. Ensure that the provided template name exists and corresponds to the authentication template name you created through your WhatsApp Business Account.
\nAfter you create a channel for your brand, you can create OTP templates.
\nThis API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/template/create' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"whatsapp\",\n \"locale\": \"tr\",\n \"templateName\": \"otp_template\"\n}'\n\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"this field must be one of these:whatsapp\",\n \"field\": \"text\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"no changes detected\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nFor effective usage, create a dedicated template for each language.
\nThe service is subject to a rate limit of 100 requests per second to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"url":"https://verify.useinsider.com/v1/template/list","description":"The Verify API enables you to generate, send, and verify OTP codes for the WhatsApp channel.
\nAfter you create a channel for your brand, you can list its templates later.
\nThis API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/template/list' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************'\n\nThis response indicates that your request was successfully completed.
\n{\n \"templates\": {\n \"whatsapp\": [\n {\n \"locale\": \"en\",\n \"text\": \"\",\n \"templateName\": \"sample_otp_template_1\"\n },\n {\n \"locale\": \"tr\",\n \"text\": \"\",\n \"templateName\": \"sample_otp_template_2\"\n }\n ]\n }\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS GET request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe service is subject to a rate limit of 100 requests per second to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"url":"https://verify.useinsider.com/v1/template/list","description":"The Verify API enables you to generate, send, and verify OTP codes for the WhatsApp channel.
\nAfter you create a channel for your brand, you can list its templates later.
\nThis API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/template/list' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************'\n\nThis response indicates that your request was successfully completed.
\n{\n \"templates\": {\n \"whatsapp\": [\n {\n \"locale\": \"en\",\n \"text\": \"\",\n \"templateName\": \"sample_otp_template_1\"\n },\n {\n \"locale\": \"tr\",\n \"text\": \"\",\n \"templateName\": \"sample_otp_template_2\"\n }\n ]\n }\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS GET request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe service is subject to a rate limit of 100 requests per second to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"whatsapp\",\n \"locale\": \"tr\",\n \"to\": \"+905XXXXXXXXX\",\n \"ttl\": 600\n}"},"url":"https://verify.useinsider.com/v1/generate","description":"The Verify API enables you to generate, send, and verify OTP codes for the WhatsApp channel. You can utilize this API to generate OTP codes as defined in the payloads. Integrating it into your own websites or apps, you can trigger it on login pages, payment pages, and more.
\nAfter you create your channel for your brand and update the templates, you need to perform the generate action for your OTP.
\nThis API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'https://verify.useinsider.com/v1/generate' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"channel\": \"whatsapp\",\n \"locale\": \"tr\",\n \"to\": \"+905XXXXXXXXX\",\n \"ttl\": 600\n}'\n\nThis response indicates that your request was successfully completed.
\n{\n \"key\": \"whatsapp-12345\",\n \"channel\": \"whatsapp\",\n \"dateCreated\": \"2023-07-28T14:40:41Z\",\n \"dateUpdated\": \"2023-07-28T14:40:41Z\",\n \"locale\": \"en\",\n \"maxAttempts\": 3,\n \"ttl\": 180\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"this field is required\",\n \"field\": \"text\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe service is subject to a rate limit of 100 requests per second to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"+905XXXXXXXXX\",\n \"code\": 1234\n}"},"url":"https://verify.useinsider.com/v1/check","description":"The Verify API enables you to generate, send, and verify OTP codes for the WhatsApp channel. You can utilize this API to generate OTP codes as defined in the payloads. Integrating it into your websites or apps, you can trigger it on login pages, payment pages, and more.
\nAfter you create your channel for your brand and update the templates, you need to perform the verification action for your OTP.
\nThis API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
\nEvery request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
\nMake sure to replace the sample values in the request header(s) and body where required before sending your request.
\ncurl --location 'verify.useinsider.com/v1/check' \\\n--header 'Content-Type: application/json' \\\n--header 'x-ins-auth-key: INS.************************' \\\n--data '{\n \"to\": \"+905XXXXXXXXX\",\n \"code\": 1234\n}'\n\nThis response indicates that your request was successfully completed.
\n{\n \"status\": \"success\"\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid request payload\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"invalid code\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"unauthorized\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"code not found\",\n \"field\": \"code\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"rate limit exceeded\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"maximum attempts exceeded\",\n \"field\": \"code\"\n }\n ]\n}\n\n{\n \"errors\": [\n {\n \"message\": \"server error\"\n }\n ]\n}\n\nAll functions must be executed with a simple HTTPS POST request.
\nThe API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThe service is subject to a rate limit of 10 requests per minute to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
\nMessaging APIs allow you to create and send Email, Web Push, App Push, and SMS campaigns from your back-end without using Insider's panel Inone.
\n","_postman_id":"e18cfc18-442f-47c3-b64c-3371a6e40ab8"},{"name":"Catalog APIs","item":[{"name":"Add New Products in a Flat Format","id":"a59b2c74-4b7f-432b-b4c4-b0b300209e0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"myPartnerName","description":"This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Catalog API token.
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1,\n \"stock_count\": 50\n },\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US:newyork\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"USD\": 119.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1,\n \"stock_count\": 12\n },\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US:losangeles\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 0,\n \"stock_count\": 0\n },\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"pt_BR\",\n \"name\": \"Velocity Runner Pro - Branco\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Calçados\", \"Corrida\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"BRL\": 899.90 },\n \"original_price\": { \"BRL\": 999.90 },\n \"in_stock\": 1,\n \"stock_count\": 30\n }\n ]","options":{"raw":{"language":"json"}}},"url":"https://catalog.api.useinsider.com/v2/ingest","description":"The Catalog API allows you to insert new products in a flat format into your product catalog. It creates new product records. If a product with the same item_id + locale already exists, it will be overwritten.
\nPOST https://catalog.api.useinsider.com/v2/ingest
\nThe following product fields should be sent as parameters in the object, along with their field name and data type, as stated. If any required fields are not sent through the Catalog API, the product is not updated or inserted.
\nCustom Product Attributes allow you to define additional details specific to your business. These attributes enrich your catalog with data that supports your unique use cases, personalization logic, and recommendation filters.
\nBefore sending Custom Product Attributes in your payload, you must define them in your account.
\nIf a Default Product Attribute already exists for the information you want to include, use the default one instead of creating a custom one. This keeps your catalog structure consistent.
\nCustom attributes are sent inside the product_attributes object:
\n{\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"product_attributes\": {\n \"material_type\": \"Leather\",\n \"season\": \"Winter\",\n \"eco_friendly\": true,\n \"collection\": \"Winter Collection 2025\",\n \"delivery_type\": \"Express\"\n }\n\nYour feed management type determines which pricing and stock attributes are required.
\nThe Stock and Revenue Based Feed Management Type is the most common type. It requires pricing and stock information.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1\n }\n ]'\n\nFor the Availability Based Feed Management Type, only the stock status is required. Pricing is optional.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"in_stock\": 1\n }\n ]'\n\nThe Published Time Based Feed Management Type requires an update timestamp instead of pricing.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"blog-top-running-shoes-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Top 10 Running Shoes for 2025\",\n \"url\": \"https://www.example-insiderone.com/blog/top-running-shoes-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/blog/running-shoes-2025.jpg\",\n \"item_update_date\": \"2025-01-15 10:30:00\"\n }\n ]'\n\nThe Start & End Time Based Feed Management Type requires date range attributes for time-bound content.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"promo-summer-clearance-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Summer Clearance Sale - Up to 50% Off\",\n \"url\": \"https://www.example-insiderone.com/campaigns/summer-clearance-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/campaigns/summer-clearance.jpg\",\n \"item_start_date\": \"2025-06-01 00:00:00\",\n \"item_end_date\": \"2025-08-31 23:59:59\"\n }\n ]'\n\nA product is considered available based on criteria that vary by feed management type:
\nPricing attributes accept an object mapping currency codes to amounts. You can include multiple currencies in a single record.
\n{\n \"price\": {\n \"USD\": 129.99,\n \"EUR\": 119.99,\n \"GBP\": 104.99,\n \"BRL\": 899.90\n },\n \"original_price\": {\n \"USD\": 149.99,\n \"EUR\": 139.99,\n \"GBP\": 119.99,\n \"BRL\": 999.90\n }\n}\n\nThe category attribute accepts an array of strings. How the array is interpreted depends on your account's category type, which is configured during onboarding. You must choose one of the two types:
\nUse this if your categories follow a parent-child structure, with subcategories nested under broader categories. Each element in the array represents a level in the hierarchy, ordered from broadest to most specific.
\n{\n \"category\": [\"Clothing\", \"Men\", \"Shirts\", \"Casual Shirts\"]\n}\n\nThis creates the hierarchy: Clothing → Men → Shirts → Casual Shirts.
\nThe order matters; the first element is the top-level category and each subsequent element is a child of the previous one.
\nUse this if your categories are independent and don't follow a parent-child hierarchy. Each element is a standalone category label at the same level.
\n{\n \"category\": [\"Men's Shirts\", \"Women's Dresses\", \"Kids' Shoes\"]\n}\n\nIn flat mode, all categories are treated equally; there is no implied nesting or ordering relationship between elements.
\nLimits:
\nCombined length of all category elements: max 1024 characters
\nEach element: max 512 characters
\nTags are used for product grouping and merchandising rules within the Insider One platform.
\n{\n \"tags\": [\"new-arrival\", \"bestseller\", \"summer-collection\", \"free-shipping\"]\n}\n\nYou can use tags to:
\nCreate product segments for personalization
\nTrigger merchandising rules
\nFilter products in recommendation widgets
\nDefine campaign audiences
\nLimits:
\nCombined length of all tags: max 4096 characters
\nEach tag: max 512 characters
\nThe groupcode attribute links product variants together as a single product group. Products sharing the same groupcode are treated as variations of the same product (e.g., different sizes or colors).
\n[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"White\",\n \"size\": \"10\"\n },\n {\n \"item_id\": \"velocity-runner-pro-black\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"Black\",\n \"size\": \"10\"\n }\n]\n\nThe sample below displays a request to insert new products into the catalog using a flat format. Each product is a separate JSON object with all fields inline. Every locale/store combination is a separate object.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: yourPartnerName\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1,\n \"stock_count\": 50\n },\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US:newyork\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"USD\": 119.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1,\n \"stock_count\": 12\n },\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US:losangeles\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 0,\n \"stock_count\": 0\n },\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"pt_BR\",\n \"name\": \"Velocity Runner Pro - Branco\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Calçados\", \"Corrida\", \"Velox\"],\n \"brand\": \"Velox\",\n \"color\": \"White\",\n \"groupcode\": \"velocity-runner-pro\",\n \"price\": { \"BRL\": 899.90 },\n \"original_price\": { \"BRL\": 999.90 },\n \"in_stock\": 1,\n \"stock_count\": 30\n }\n ]'\n\nAll ingest endpoints return the same response structure:
\n{\n \"success\": true,\n \"message\": {\n \"valid\": {\n \"count\": 95\n },\n \"invalid\": {\n \"count\": 5,\n \"details\": [\n {\n \"field\": \"original_price\",\n \"message\": \"Field is invalidated: 'original_price' is required\",\n \"count\": 2,\n \"document_ids\": [\"item-1\", \"item-2\"]\n },\n {\n \"field\": \"url\",\n \"message\": \"Field is invalidated: 'url' must match pattern\",\n \"count\": 3,\n \"document_ids\": [\"item-3\", \"item-4\", \"item-5\"]\n }\n ]\n },\n \"warnings\": {\n \"count\": 1,\n \"details\": [\n {\n \"field\": \"image_url\",\n \"message\": \"Image URL could not be validated\",\n \"count\": 1,\n \"document_ids\": [\"item-6\"]\n }\n ]\n },\n \"invalidRatio\": 0.05\n }\n }\n\n\n\nWarnings are informational and do not prevent records from being processed.
\n
For all the limits applied, refer to Limitations.
\n","urlObject":{"protocol":"https","path":["v2","ingest"],"host":["catalog","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a59b2c74-4b7f-432b-b4c4-b0b300209e0c"},{"name":"Add New Products in a Nested Format","id":"f7f838cf-3525-452a-968a-bdc06718516c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"myPartnerName","description":"This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Catalog API token.
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"base\": {\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"brand\": \"Velox\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"White\"\n },\n \"locales\": {\n \"en_US\": {\n \"name\": \"Velocity Runner Pro - White\",\n \"category\": [\n \"Shoes\",\n \"Running\",\n \"Velox\"\n ],\n \"price\": {\n \"USD\": 129.99\n },\n \"original_price\": {\n \"USD\": 149.99\n },\n \"stores\": {\n \"main\": {\n \"in_stock\": 1,\n \"stock_count\": 50\n },\n \"newyork\": {\n \"price\": {\n \"USD\": 119.99\n },\n \"in_stock\": 1,\n \"stock_count\": 12\n },\n \"losangeles\": {\n \"in_stock\": 0,\n \"stock_count\": 0\n }\n }\n },\n \"pt_BR\": {\n \"name\": \"Velocity Runner Pro - Branco\",\n \"category\": [\n \"Calçados\",\n \"Corrida\",\n \"Velox\"\n ],\n \"price\": {\n \"BRL\": 899.90\n },\n \"original_price\": {\n \"BRL\": 999.90\n },\n \"stores\": {\n \"main\": {\n \"in_stock\": 1,\n \"stock_count\": 30\n }\n }\n }\n }\n }\n ]","options":{"raw":{"language":"json"}}},"url":"https://catalog.api.useinsider.com/v2/ingest/nested","description":"The Catalog API allows you to insert new items into your product catalog in a nested format. It creates new product records. If a product with the same item_id + locale already exists, it will be overwritten.
\nPOST https://catalog.api.useinsider.com/v2/ingest/nested
\nThe following product fields should be sent as parameters in the object, along with their field name and data type, as stated. If any required fields are not sent through the Catalog API, the product is not updated or inserted.
\nCustom Product Attributes allow you to define additional details specific to your business. These attributes enrich your catalog with data that supports your unique use cases, personalization logic, and recommendation filters.
\nBefore sending Custom Product Attributes in your payload, you must define them in your account.
\nIf a Default Product Attribute already exists for the information you want to include, use the default one instead of creating a custom one. This keeps your catalog structure consistent.
\nCustom attributes are sent inside the product_attributes object:
\n{\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"product_attributes\": {\n \"material_type\": \"Leather\",\n \"season\": \"Winter\",\n \"eco_friendly\": true,\n \"collection\": \"Winter Collection 2025\",\n \"delivery_type\": \"Express\"\n }\n\nYour feed management type determines which pricing and stock attributes are required.
\nThe Stock and Revenue Based Feed Management Type is the most common type. It requires pricing and stock information.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1\n }\n ]'\n\nFor the Availability Based Feed Management Type, only the stock status is required. Pricing is optional.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"in_stock\": 1\n }\n ]'\n\nThe Published Time Based Feed Management Type requires an update timestamp instead of pricing.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"blog-top-running-shoes-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Top 10 Running Shoes for 2025\",\n \"url\": \"https://www.example-insiderone.com/blog/top-running-shoes-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/blog/running-shoes-2025.jpg\",\n \"item_update_date\": \"2025-01-15 10:30:00\"\n }\n ]'\n\nThe Start & End Time Based Feed Management Type requires date range attributes for time-bound content.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"promo-summer-clearance-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Summer Clearance Sale - Up to 50% Off\",\n \"url\": \"https://www.example-insiderone.com/campaigns/summer-clearance-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/campaigns/summer-clearance.jpg\",\n \"item_start_date\": \"2025-06-01 00:00:00\",\n \"item_end_date\": \"2025-08-31 23:59:59\"\n }\n ]'\n\nA product is considered available based on criteria that vary by feed management type:
\nPricing attributes accept an object mapping currency codes to amounts. You can include multiple currencies in a single record.
\n{\n \"price\": {\n \"USD\": 129.99,\n \"EUR\": 119.99,\n \"GBP\": 104.99,\n \"BRL\": 899.90\n },\n \"original_price\": {\n \"USD\": 149.99,\n \"EUR\": 139.99,\n \"GBP\": 119.99,\n \"BRL\": 999.90\n }\n}\n\nThe category attribute accepts an array of strings. How the array is interpreted depends on your account's category type, which is configured during onboarding. You must choose one of the two types:
\nUse this if your categories follow a parent-child structure, with subcategories nested under broader categories. Each element in the array represents a level in the hierarchy, ordered from broadest to most specific.
\n{\n \"category\": [\"Clothing\", \"Men\", \"Shirts\", \"Casual Shirts\"]\n}\n\nThis creates the hierarchy: Clothing → Men → Shirts → Casual Shirts.
\nThe order matters; the first element is the top-level category and each subsequent element is a child of the previous one.
\nUse this if your categories are independent and don't follow a parent-child hierarchy. Each element is a standalone category label at the same level.
\n{\n \"category\": [\"Men's Shirts\", \"Women's Dresses\", \"Kids' Shoes\"]\n}\n\nIn flat mode, all categories are treated equally; there is no implied nesting or ordering relationship between elements.
\nLimits:
\nCombined length of all category elements: max 1024 characters
\nEach element: max 512 characters
\nTags are used for product grouping and merchandising rules within the Insider One platform.
\n{\n \"tags\": [\"new-arrival\", \"bestseller\", \"summer-collection\", \"free-shipping\"]\n}\n\nYou can use tagsto:
\nCreate product segments for personalization
\nTrigger merchandising rules
\nFilter products in recommendation widgets
\nDefine campaign audiences
\nLimits:
\nCombined length of all tags: max 4096 characters
\nEach tag: max 512 characters
\nThe groupcode attribute links product variants together as a single product group. Products sharing the same groupcode are treated as variations of the same product (e.g., different sizes or colors).
\n[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"White\",\n \"size\": \"10\"\n },\n {\n \"item_id\": \"velocity-runner-pro-black\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"Black\",\n \"size\": \"10\"\n }\n]\n\nThe sample below displays a request to insert new products using a nested format. Shared fields go in base, locale-specific fields go in locales, and store overrides go in stores.
\nUse nested format when you have multiple locales or stores per product. Shared fields like url, image_url, and brand are defined once and inherited by all locales/stores, reducing payload size and repetition.
\nThe following example is equivalent to the flat format: the same product, locales, and stores, but expressed as a single nested object instead of 4 separate records:
\ncurl --request POST \"https://catalog.api.useinsider.com/v2/ingest/nested\" \\\n --header \"Content-Type: application/json\" \\\n --header \"X-PARTNER-NAME: yourPartnerName\" \\\n --header \"X-REQUEST-TOKEN: your-api-token\" \\\n --data '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"base\": {\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"brand\": \"Velox\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"White\"\n },\n \"locales\": {\n \"en_US\": {\n \"name\": \"Velocity Runner Pro - White\",\n \"category\": [\n \"Shoes\",\n \"Running\",\n \"Velox\"\n ],\n \"price\": {\n \"USD\": 129.99\n },\n \"original_price\": {\n \"USD\": 149.99\n },\n \"stores\": {\n \"main\": {\n \"in_stock\": 1,\n \"stock_count\": 50\n },\n \"newyork\": {\n \"price\": {\n \"USD\": 119.99\n },\n \"in_stock\": 1,\n \"stock_count\": 12\n },\n \"losangeles\": {\n \"in_stock\": 0,\n \"stock_count\": 0\n }\n }\n },\n \"pt_BR\": {\n \"name\": \"Velocity Runner Pro - Branco\",\n \"category\": [\n \"Calçados\",\n \"Corrida\",\n \"Velox\"\n ],\n \"price\": {\n \"BRL\": 899.90\n },\n \"original_price\": {\n \"BRL\": 999.90\n },\n \"stores\": {\n \"main\": {\n \"in_stock\": 1,\n \"stock_count\": 30\n }\n }\n }\n }\n }\n ]'\n\nIn nested format, the same field can be defined at multiple levels (base, locale, store). The Catalog API merges these into a final record using this priority:
\nstore fields > locale fields > base fields\n\nThis allows you to define shared values once in the base and only override the differences at each level.
\nExample: In the request above, en_US defines price: USD 129.99 at the locale level. The newyork store overrides this with price: USD 119.99, while losangeles inherits the locale price since it doesn't define its own:
\nIn the nested payload structure, fields can be defined at three levels:
\nbase → Shared across all locales and stores\n locales → Locale-specific (name, category, etc.)\n └─ stores → Store-specific overrides (pricing and stock only)\n\nOnly the following fields are allowed at the store level:
\nprice
\noriginal_price
\nomnibus_price
\nin_stock
\nstock_count
\nIncluding any other field at the store level returns a 400 error.
\nExample: A valid nested payload with store-level overrides:
\n{\n \"item_id\": \"SKU-123\",\n \"base\": {\n \"url\": \"https://example.com/product/SKU-123\",\n \"image_url\": \"https://cdn.example.com/SKU-123.jpg\",\n \"brand\": \"Acme\"\n },\n \"locales\": {\n \"en_US\": {\n \"name\": \"Example Product\",\n \"category\": [\"Electronics\"],\n \"price\": { \"USD\": 99.99 },\n \"original_price\": { \"USD\": 119.99 },\n \"in_stock\": 1,\n \"stores\": {\n \"main\": {\n \"stock_count\": 100\n },\n \"outlet\": {\n \"price\": { \"USD\": 79.99 },\n \"in_stock\": 1,\n \"stock_count\": 25\n }\n }\n }\n }\n }\n\nThis produces two records:
\nen_US with price USD 99.99 and stock_count 100
\nen_US:outlet with price USD 79.99 and stock_count 25
\nThe main key is a reserved store identifier that represents the default/locale-level record. Unlike other store keys, it does not append a suffix to the locale string. For example, \"main\" under en_US produces a record with locale en_US, while \"newyork\" produces en_US:newyork.
\n\n\n<p >This is useful when you want to define a base price/stock for the locale itself alongside store-specific overrides. If you use main without any other stores, the result is the same as not using stores at all.</p>
\n
All ingest endpoints return the same response structure:
\n{\n \"success\": true,\n \"message\": {\n \"valid\": {\n \"count\": 95\n },\n \"invalid\": {\n \"count\": 5,\n \"details\": [\n {\n \"field\": \"original_price\",\n \"message\": \"Field is invalidated: 'original_price' is required\",\n \"count\": 2,\n \"document_ids\": [\"item-1\", \"item-2\"]\n },\n {\n \"field\": \"url\",\n \"message\": \"Field is invalidated: 'url' must match pattern\",\n \"count\": 3,\n \"document_ids\": [\"item-3\", \"item-4\", \"item-5\"]\n }\n ]\n },\n \"warnings\": {\n \"count\": 1,\n \"details\": [\n {\n \"field\": \"image_url\",\n \"message\": \"Image URL could not be validated\",\n \"count\": 1,\n \"document_ids\": [\"item-6\"]\n }\n ]\n },\n \"invalidRatio\": 0.05\n }\n }\n\nWarnings are informational and do not prevent records from being processed.
\nFor all the limits applied, refer to Limitations.
\n","urlObject":{"protocol":"https","path":["v2","ingest","nested"],"host":["catalog","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7f838cf-3525-452a-968a-bdc06718516c"},{"name":"Update Existing Products in a Flat Format","id":"12f60b5c-f7a7-46de-a1d9-90d1f22cdead","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"myPartnerName","description":"This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Catalog API token.
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"price\": { \"USD\": 109.99 },\n \"in_stock\": 0\n }\n ]","options":{"raw":{"language":"json"}}},"url":"https://catalog.api.useinsider.com/v2/update","description":"The Catalog API allows you to update existing products in your product catalog. You can send only the fields you want to change, and it supports partial updates. You can send only the fields you want to change, or send all fields if that's easier for your integration. Both approaches work.
\nPOST https://catalog.api.useinsider.com/v2/update
\nThe following product fields should be sent as parameters in the object, along with their field name and data type, as stated. If any required fields are not sent through the Catalog API, the product is not updated or inserted.
\nCustom Product Attributes allow you to define additional details specific to your business. These attributes enrich your catalog with data that supports your unique use cases, personalization logic, and recommendation filters.
\nBefore sending Custom Product Attributes in your payload, you must define them in your account.
\nIf a Default Product Attribute already exists for the information you want to include, use the default one instead of creating a custom one. This keeps your catalog structure consistent.
\nCustom attributes are sent inside the product_attributes object:
\n{\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"product_attributes\": {\n \"material_type\": \"Leather\",\n \"season\": \"Winter\",\n \"eco_friendly\": true,\n \"collection\": \"Winter Collection 2025\",\n \"delivery_type\": \"Express\"\n }\n\nYour feed management type determines which pricing and stock attributes are required.
\nThe Stock and Revenue Based Feed Management Type is the most common type. It requires pricing and stock information.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1\n }\n ]'\n\nFor the Availability Based Feed Management Type, only the stock status is required. Pricing is optional.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"in_stock\": 1\n }\n ]'\n\nThe Published Time Based Feed Management Type requires an update timestamp instead of pricing.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"blog-top-running-shoes-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Top 10 Running Shoes for 2025\",\n \"url\": \"https://www.example-insiderone.com/blog/top-running-shoes-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/blog/running-shoes-2025.jpg\",\n \"item_update_date\": \"2025-01-15 10:30:00\"\n }\n ]'\n\nThe Start & End Time Based Feed Management Type requires date range attributes for time-bound content.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"promo-summer-clearance-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Summer Clearance Sale - Up to 50% Off\",\n \"url\": \"https://www.example-insiderone.com/campaigns/summer-clearance-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/campaigns/summer-clearance.jpg\",\n \"item_start_date\": \"2025-06-01 00:00:00\",\n \"item_end_date\": \"2025-08-31 23:59:59\"\n }\n ]'\n\nA product is considered available based on criteria that vary by feed management type:
\nPricing attributes accept an object mapping currency codes to amounts. You can include multiple currencies in a single record.
\n{\n \"price\": {\n \"USD\": 129.99,\n \"EUR\": 119.99,\n \"GBP\": 104.99,\n \"BRL\": 899.90\n },\n \"original_price\": {\n \"USD\": 149.99,\n \"EUR\": 139.99,\n \"GBP\": 119.99,\n \"BRL\": 999.90\n }\n}\n\nThe category attribute accepts an array of strings. How the array is interpreted depends on your account's category type, which is configured during onboarding. You must choose one of the two types:
\nUse this if your categories follow a parent-child structure, with subcategories nested under broader categories. Each element in the array represents a level in the hierarchy, ordered from broadest to most specific.
\n{\n \"category\": [\"Clothing\", \"Men\", \"Shirts\", \"Casual Shirts\"]\n}\n\nThis creates the hierarchy: Clothing → Men → Shirts → Casual Shirts.
\nThe order matters; the first element is the top-level category and each subsequent element is a child of the previous one.
\nUse this if your categories are independent and don't follow a parent-child hierarchy. Each element is a standalone category label at the same level.
\n{\n \"category\": [\"Men's Shirts\", \"Women's Dresses\", \"Kids' Shoes\"]\n}\n\nIn flat mode, all categories are treated equally; there is no implied nesting or ordering relationship between elements.
\nLimits:
\nCombined length of all category elements: max 1024 characters
\nEach element: max 512 characters
\nTags are used for product grouping and merchandising rules within the Insider One platform.
\n{\n \"tags\": [\"new-arrival\", \"bestseller\", \"summer-collection\", \"free-shipping\"]\n}\n\nYou can use tags to:
\nCreate product segments for personalization
\nTrigger merchandising rules
\nFilter products in recommendation widgets
\nDefine campaign audiences
\nLimits:
\nCombined length of all tags: max 4096 characters
\nEach tag: max 512 characters
\nThe groupcode attribute links product variants together as a single product group. Products sharing the same groupcode are treated as variations of the same product (e.g., different sizes or colors).
\n[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"White\",\n \"size\": \"10\"\n },\n {\n \"item_id\": \"velocity-runner-pro-black\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"Black\",\n \"size\": \"10\"\n }\n]\n\nThe sample below displays a request to insert new products into the catalog using a flat format. Each product is a separate JSON object with all fields inline. Every locale/store combination is a separate object.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/update\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"price\": { \"USD\": 109.99 },\n \"in_stock\": 0\n }\n ]'\n\nAll ingest endpoints return the same response structure:
\n{\n \"success\": true,\n \"message\": {\n \"valid\": {\n \"count\": 95\n },\n \"invalid\": {\n \"count\": 5,\n \"details\": [\n {\n \"field\": \"original_price\",\n \"message\": \"Field is invalidated: 'original_price' is required\",\n \"count\": 2,\n \"document_ids\": [\"item-1\", \"item-2\"]\n },\n {\n \"field\": \"url\",\n \"message\": \"Field is invalidated: 'url' must match pattern\",\n \"count\": 3,\n \"document_ids\": [\"item-3\", \"item-4\", \"item-5\"]\n }\n ]\n },\n \"warnings\": {\n \"count\": 1,\n \"details\": [\n {\n \"field\": \"image_url\",\n \"message\": \"Image URL could not be validated\",\n \"count\": 1,\n \"document_ids\": [\"item-6\"]\n }\n ]\n },\n \"invalidRatio\": 0.05\n }\n }\n\n\n\nWarnings are informational and do not prevent records from being processed.
\n
For all the limits applied, refer to Limitations.
\n","urlObject":{"protocol":"https","path":["v2","update"],"host":["catalog","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"12f60b5c-f7a7-46de-a1d9-90d1f22cdead"},{"name":"Update Existing Products in a Nested Format","id":"ed214937-3717-4182-b082-5be9573acf12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"myPartnerName","description":"This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Catalog API token.
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locales\": {\n \"en_US\": {\n \"price\": { \"USD\": 109.99 },\n \"stores\": {\n \"newyork\": {\n \"in_stock\": 0,\n \"stock_count\": 0\n }\n }\n }\n }\n }\n ]","options":{"raw":{"language":"json"}}},"url":"https://catalog.api.useinsider.com/v2/update/nested","description":"The Catalog API allows you to update existing products in your product catalog using a nested format. You can send only the fields you want to change, and it supports partial updates. You can send only the fields you want to change, or send all fields if that's easier for your integration. Both approaches work.
\nPOST https://catalog.api.useinsider.com/v2/update/nested
\nThe following product fields should be sent as parameters in the object, along with their field name and data type, as stated. If any required fields are not sent through the Catalog API, the product is not updated or inserted.
\nThe following product fields should be sent as parameters in the object, along with their field name and data type, as stated. If any required fields are not sent through the Catalog API, the product is not updated or inserted.
\nCustom Product Attributes allow you to define additional details specific to your business. These attributes enrich your catalog with data that supports your unique use cases, personalization logic, and recommendation filters.
\nBefore sending Custom Product Attributes in your payload, you must define them in your account.
\nIf a Default Product Attribute already exists for the information you want to include, use the default one instead of creating a custom one. This keeps your catalog structure consistent.
\nCustom attributes are sent inside the product_attributes object:
\n{\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"product_attributes\": {\n \"material_type\": \"Leather\",\n \"season\": \"Winter\",\n \"eco_friendly\": true,\n \"collection\": \"Winter Collection 2025\",\n \"delivery_type\": \"Express\"\n }\n\nYour feed management type determines which pricing and stock attributes are required.
\nThe Stock and Revenue Based Feed Management Type is the most common type. It requires pricing and stock information.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"category\": [\"Shoes\", \"Running\", \"Velox\"],\n \"brand\": \"Velox\",\n \"price\": { \"USD\": 129.99 },\n \"original_price\": { \"USD\": 149.99 },\n \"in_stock\": 1\n }\n ]'\n\nFor the Availability Based Feed Management Type, only the stock status is required. Pricing is optional.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locale\": \"en_US\",\n \"name\": \"Velocity Runner Pro - White\",\n \"url\": \"https://www.example-insiderone.com/shoes/velocity-runner-pro-white\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/velocity-runner-pro-white.jpg\",\n \"in_stock\": 1\n }\n ]'\n\nThe Published Time Based Feed Management Type requires an update timestamp instead of pricing.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"blog-top-running-shoes-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Top 10 Running Shoes for 2025\",\n \"url\": \"https://www.example-insiderone.com/blog/top-running-shoes-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/blog/running-shoes-2025.jpg\",\n \"item_update_date\": \"2025-01-15 10:30:00\"\n }\n ]'\n\nThe Start & End Time Based Feed Management Type requires date range attributes for time-bound content.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/ingest\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"promo-summer-clearance-2025\",\n \"locale\": \"en_US\",\n \"name\": \"Summer Clearance Sale - Up to 50% Off\",\n \"url\": \"https://www.example-insiderone.com/campaigns/summer-clearance-2025\",\n \"image_url\": \"https://cdn.example-insiderone.com/images/campaigns/summer-clearance.jpg\",\n \"item_start_date\": \"2025-06-01 00:00:00\",\n \"item_end_date\": \"2025-08-31 23:59:59\"\n }\n ]'\n\nA product is considered available based on criteria that vary by feed management type:
\nPricing attributes accept an object mapping currency codes to amounts. You can include multiple currencies in a single record.
\n{\n \"price\": {\n \"USD\": 129.99,\n \"EUR\": 119.99,\n \"GBP\": 104.99,\n \"BRL\": 899.90\n },\n \"original_price\": {\n \"USD\": 149.99,\n \"EUR\": 139.99,\n \"GBP\": 119.99,\n \"BRL\": 999.90\n }\n}\n\nThe category attribute accepts an array of strings. How the array is interpreted depends on your account's category type, which is configured during onboarding. You must choose one of the two types:
\nUse this if your categories follow a parent-child structure, with subcategories nested under broader categories. Each element in the array represents a level in the hierarchy, ordered from broadest to most specific.
\n{\n \"category\": [\"Clothing\", \"Men\", \"Shirts\", \"Casual Shirts\"]\n}\n\nThis creates the hierarchy: Clothing → Men → Shirts → Casual Shirts.
\nThe order matters; the first element is the top-level category and each subsequent element is a child of the previous one.
\nUse this if your categories are independent and don't follow a parent-child hierarchy. Each element is a standalone category label at the same level.
\n{\n \"category\": [\"Men's Shirts\", \"Women's Dresses\", \"Kids' Shoes\"]\n}\n\nIn flat mode, all categories are treated equally; there is no implied nesting or ordering relationship between elements.
\nLimits:
\nCombined length of all category elements: max 1024 characters
\nEach element: max 512 characters
\nTags are used for product grouping and merchandising rules within the Insider One platform.
\n{\n \"tags\": [\"new-arrival\", \"bestseller\", \"summer-collection\", \"free-shipping\"]\n}\n\nYou can use tags to:
\nCreate product segments for personalization
\nTrigger merchandising rules
\nFilter products in recommendation widgets
\nDefine campaign audiences
\nLimits:
\nCombined length of all tags: max 4096 characters
\nEach tag: max 512 characters
\nThe groupcode attribute links product variants together as a single product group. Products sharing the same groupcode are treated as variations of the same product (e.g., different sizes or colors).
\n[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"White\",\n \"size\": \"10\"\n },\n {\n \"item_id\": \"velocity-runner-pro-black\",\n \"groupcode\": \"velocity-runner-pro\",\n \"color\": \"Black\",\n \"size\": \"10\"\n }\n]\n\nThe sample below displays a request to update products in the product catalog using a nested format. Each product is a separate JSON object with all fields inline.
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/update/nested\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: yourPartnerName\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '[\n {\n \"item_id\": \"velocity-runner-pro-white\",\n \"locales\": {\n \"en_US\": {\n \"price\": { \"USD\": 109.99 },\n \"stores\": {\n \"newyork\": {\n \"in_stock\": 0,\n \"stock_count\": 0\n }\n }\n }\n }\n }\n ]'\n\nIn nested format, the same field can be defined at multiple levels (base, locale, store). The Catalog API merges these into a final record using this priority:
\nstore fields > locale fields > base fields\n\nThis allows you to define shared values once in the base and only override the differences at each level.
\nExample: In the request above, en_US defines price: USD 129.99 at the locale level. The newyork store overrides this with price: USD 119.99, while losangeles inherits the locale price since it doesn't define its own:
\nIn the nested payload structure, fields can be defined at three levels:
\nbase → Shared across all locales and stores\n locales → Locale-specific (name, category, etc.)\n └─ stores → Store-specific overrides (pricing and stock only)\n\nOnly the following fields are allowed at the store level:
\nprice
\noriginal_price
\nomnibus_price
\nin_stock
\nstock_count
\nIncluding any other field at the store level returns a 400 error.
\nExample: A valid nested payload with store-level overrides:
\n{\n \"item_id\": \"SKU-123\",\n \"base\": {\n \"url\": \"https://example.com/product/SKU-123\",\n \"image_url\": \"https://cdn.example.com/SKU-123.jpg\",\n \"brand\": \"Acme\"\n },\n \"locales\": {\n \"en_US\": {\n \"name\": \"Example Product\",\n \"category\": [\"Electronics\"],\n \"price\": { \"USD\": 99.99 },\n \"original_price\": { \"USD\": 119.99 },\n \"in_stock\": 1,\n \"stores\": {\n \"main\": {\n \"stock_count\": 100\n },\n \"outlet\": {\n \"price\": { \"USD\": 79.99 },\n \"in_stock\": 1,\n \"stock_count\": 25\n }\n }\n }\n }\n }\n\nThis produces two records:
\nen_US with price USD 99.99 and stock_count 100
\nen_US:outlet with price USD 79.99 and stock_count 25
\nThe main key is a reserved store identifier that represents the default/locale-level record. Unlike other store keys, it does not append a suffix to the locale string. For example, \"main\" under en_US produces a record with locale en_US, while \"newyork\" produces en_US:newyork.
\n\n\nThis is useful when you want to define a base price/stock for the locale itself alongside store-specific overrides. If you use main without any other stores, the result is the same as not using stores at all.
\n
For all the limits applied, refer to Limitations.
\n","urlObject":{"protocol":"https","path":["v2","update","nested"],"host":["catalog","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed214937-3717-4182-b082-5be9573acf12"},{"name":"Create Locale Configurations","id":"3333a8a0-150a-4166-86f2-21393717e2ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PARTNER-NAME","value":"myParterName","description":"This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your Catalog API token.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"locales\": [\n { \"language_country_code\": \"en_US\", \"store_id\": \"Main\" },\n { \"language_country_code\": \"pt_BR\", \"store_id\": \"SaoPaulo\" }\n ]\n }\n }","options":{"raw":{"language":"json"}}},"url":"https://catalog.api.useinsider.com/v2/locales/batch","description":"The Catalog API allows you to create locale configurations. For larger or more complex setups, the Create Locale endpoint enables faster and more scalable locale management.
\nRefer to Locales for further information.
\n\n\n
POST https://catalog.api.useinsider.com/v2/locales/batch
\nThe sample below displays a request to create locale configurations:
\ncurl -X POST \"https://catalog.api.useinsider.com/v2/locales/batch\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-PARTNER-NAME: your-partner-name\" \\\n -H \"X-REQUEST-TOKEN: your-api-token\" \\\n -d '{\n \"data\": {\n \"locales\": [\n { \"language_country_code\": \"en_US\", \"store_id\": \"Main\" },\n { \"language_country_code\": \"pt_BR\", \"store_id\": \"SaoPaulo\" }\n ]\n }\n }'\n\n{\n \"success\": true, \n \"created_locale_count\": 1\n}\n\nFor all the limits applied, refer to Limitations.
\n","urlObject":{"protocol":"https","path":["v2","locales","batch"],"host":["catalog","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3333a8a0-150a-4166-86f2-21393717e2ea"}],"id":"a73c6655-4bce-43ed-9046-3e0038604a6b","description":"The Catalog API enables you to send your product catalog data to the Insider One platform. You can ingest new products, update existing ones, and manage locale configurations through a set of REST endpoints.
\nProduct data powers Insider One's personalization, recommendation, and merchandising features. Keeping your catalog up to date ensures accurate product information across all Insider One powered experiences on your website, app, and messaging channels.
\nThe Catalog API has five different endpoints with different functions:
\nPOST /v2/ingest to add new products in a flat format
\nPOST /v2/ingest/nested to add new products in a nested format
\nPOST /v2/update to update existing products in a flat format
\nPOST /v2/update/nested to update existing products (nested format)
\nPOST /v2/locales/batch to create locale configurations
\n\n\n
Ingest vs Update:
\nIngest creates new product records. If a product with the same item_id + locale already exists, it will be overwritten.
\nUpdate modifies existing products. You can send only the fields you want to change (partial update).
\nThe key concepts while using the Catalog API are:
\nA locale identifies the market context for your product data. It combines a language/country code with an optional store identifier, enabling you to serve localized content and region-specific pricing to different markets.
\nProducts can exist in multiple locales simultaneously. Each locale maintains its own product name, description, pricing, categories, and stock data, allowing you to manage a global catalog from a single integration.
\n\n\n<p >The locale value in your API payload must exactly match a locale defined in your account. Payloads with undefined locales will not be ingested.</p>
\n
The base locale follows the ISO standard format {language}_{COUNTRY} (e.g., en_US, pt_BR, de_DE). It determines the language of your product names/descriptions and the country context of your catalog.
\nWhen using stores, the locale value is extended with a store suffix: {locale}:{store} (e.g., en_US:newyork).
\nA store sits under a locale and represents a specific warehouse, retail branch, delivery hub, or virtual storefront within that locale. Stores enable inventory segmentation; prices, availability, and stock can differ by store.
\nStore-level data is limited to pricing and stock fields only (price, original_price, omnibus_price, in_stock, stock_count). All other product attributes (name, category, image, etc.) are defined at the locale level and shared across stores.
\nYou can create and manage locales through the Insider One’s InOne panel.
\nAlternatively, you can create locales in bulk via the Catalog API using the Create Locale API.
\nFor stores with a small number of locales, creating locales through the InOne panel is quick and straightforward.
\nFor larger or more complex setups, the Create Locale API enables faster and more scalable locale management.
\nYour account is configured with a Feed Management Type that determines which pricing/stock fields are required in your product payloads.
\nEvery Ingest request requires core product fields (item_id, locale, name, url, image_url). Based on your Feed Management Type, some fields are added as required fields on top of these:
\n\n\n
Your feed management type is selected during the onboarding process. If you are unsure which type applies to your integration, check your Catalog Settings or contact the Insider One team.
\nThe Catalog API enforces limits on request size, field lengths, and field values to ensure data quality and system stability. Records that exceed these limits will be rejected or reported as invalid in the response.
\nEach Catalog API call counts as one request regardless of how many records it contains. To maximize throughput, batch as many records as possible per request (up to 10,000) rather than sending many small requests.
\nExample: If you send 60 requests within a 1-minute window, subsequent requests will be rejected with 429 Too Many Requests until the oldest requests fall outside the window.
\nFields that exceed the maximum length will cause the individual record to be marked as invalid. Other records in the same request are not affected.
\nThe following constraints are enforced during validation. Records that violate these rules will be marked as invalid in the response with a corresponding error detail.
\nWhen updating products, price and original_price must be sent together if either is included.
\nFor updates with present=true, products not found in the catalog will be reported as errors.
\nMaximum 1000 locales can be created.
\nMaximum 64 characters for locale + store key combined
\n\n\n<p >The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.</p>
\n
The Catalog API distinguishes between request-level and record-level errors:
\nRequest-level errors (4xx) mean the entire request was rejected; no records were processed. These occur for authentication failures, malformed JSON, or exceeding request size/count limits.
\nRecord-level errors are returned inside a 200 response. Even if every record in your payload is invalid, the API still returns 200. You must always check the response body to determine how many records were accepted and how many failed.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/chef","description":"Chef is an automated recommendation algorithm that automatically identifies the best mixed strategy by testing the most popular items, top sellers, user-based, highest-discounted, new arrivals, and trending items algorithms to improve conversion rates. In a mixed strategy, you manually choose an algorithm for each slot. Chef, instead, chooses the best combination by automatically evaluating the algorithms' performance.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/chef
\nThe sample below shows a request to Chef, an automated recommendation strategy that picks the best-performing mix (popular items, top sellers, user-based, highest-discounted, new arrivals, trending, etc.) per slot—no manual algorithm selection required.
\nhttps://recommendation.api.useinsider.com/v2/chef?partnerName={PartnerName}&locale={Locale}\n\n{\n \"success\": true,\n \"total\": 16,\n \"types\": {\n \"mpop\": 14,\n \"mvop\": 2\n },\n \"data\": [\n \"ABC1234\",\n \"ABC1243\",\n \"ABC1234\",\n \"ABC1235\",\n \"ABC1237\",\n \"ABC1230\",\n \"ABC1263\",\n \"ABC1209\",\n \"ABC1256\",\n \"CBA1234\",\n \"CBA1233\",\n \"CBA1236\",\n \"CBA1239\",\n \"CBA1221\",\n \"CBA1209\",\n \"CBA1247\"\n ]\n }\n\nThe Chef algorithm doesn't have a specific fallback mechanism; instead, fallback algorithms are determined by the individual algorithms selected by Chef.
\n","urlObject":{"protocol":"https","path":["v2","chef"],"host":["recommendation","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb847166-d404-4aff-a05f-4885286452f9"},{"name":"Complementary Products","id":"1b6352a7-febd-45bc-a661-fdd7a5f51ce9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/complementary","description":"The Complementary Products algorithm represents a different approach compared to Collaborative Algorithms, which are typically used to complement product recommendations. It is particularly effective on product pages and cart pages.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/complementary
\nThe sample below displays a request to Complementary Products, the algorithm that suggests items frequently bought or viewed together with the anchor product.
\nhttps://recommendation.api.useinsider.com/v2/complementary?partnerName={PartnerName}&locale={Locale}&productId={ProductId}\n\n{\n \"success\": true,\n \"total\": 5,\n \"types\": {\n \"cp\": 5\n },\n \"data\": [\n \"ABC321Z8\",\n \"ABC312Z8\",\n \"ABC123Z8\",\n \"ABC234Z8\",\n \"ABC345Z8\"\n ]\n }\n\nIf the products from Complementary Products are not enough to fill the response data, some fallback algorithms below fill it:
\nPurchased Together
\nTop Sellers of Category
\nTop Sellers
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/highest-discounted","description":"The Highest Discounted Products algorithm recommends products based on their discount ratios, prioritizing those with higher discounts. It calculates the discount ratio for each product using the original and discounted prices. Recommended products will be sorted from highest to lowest discount for the given size. For each currency type, the discount ratio is calculated separately. This type of algorithm works best on main and category pages.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/highest-discounted
\nIf you want to get top sellers products from the category or categories you want, specify either categoryList or category and subCategory.
\nThe sample below displays a request for the Highest Discounted Products; the algorithm recommends products based on their discount ratios, prioritizing those with higher discounts.
\nhttps://recommendation.api.useinsider.com/v2/highest-discounted?partnerName={Partner Name}&locale={Locale}&size=5¤cy={Currency}\n\n{\n \"success\": true,\n \"total\": 5,\n \"types\": {\n \"hdop\": 5\n },\n \"data\": [\n \"AB76543\",\n \"AB54321\",\n \"YZ76543\",\n \"AB49876\",\n \"AB01234\"\n ]\n }\n\nIf the products from the Highest Discounted Products are not enough to fill the response data, some fallback algorithms below fill it:
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/manual-merchandising","description":"The Manual Merchandising algorithm retrieves product details manually specified and returns only in-stock products. It enables you to showcase specific products or content (e.g., for special days) from a list specified in the campaign configuration. In addition, only in-stock products will be displayed in the recommendation widget. This type of algorithm can be used on all page types to promote specific products.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/manual-merchandising
\nYou need to write Product IDs as comma-separated in the productId parameter, such as productId=ed061306,287a4a89,8f0db743,69de9b05
\nThe sample below displays a request to the Manual Merchandising algorithm:
\nhttps://recommendation.api.useinsider.com/v2/manual-merchandising?partnerName={Partner Name}&locale={Locale}&productId=ABC12345,XYZ12345\n\n{\n \"success\": true,\n \"total\": 2,\n \"types\": {\n \"mm\": 2\n },\n \"data\": [\n \"ABC12345\",\n \"XYZ12345\"\n ]\n}\n\nThere is no fallback algorithm for this recommendation type, as only requested items are recommended.
\n","urlObject":{"protocol":"https","path":["v2","manual-merchandising"],"host":["recommendation","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c73b16d5-bbc9-4234-84f9-cb8670aba821"},{"name":"Mixed Strategy","id":"f433ab29-d1d6-4461-924b-c3e2b2dfdadc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/mixed","description":"The Mixed Strategy algorithm creates a customized, mixed recommendation strategy that combines different recommendation types. It is a way to use different algorithms for each slot in the Recommendation Widget. The mixed strategy allows you to use multiple algorithms in a single recommendation widget on your website. It works best on the main and category pages.
\nThe duplicated items are automatically removed by the Mixed Strategy algorithm.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/mixed
\nYou need to add the necessary query parameters for the strategy or strategies you are using.
\nStrategy is used to specify the desired recommendation types and sizes. Strategies are given within an array. Each strategy is an object that contains the keys recommendationType and size. recommendationType indicates the type of recommendation required, while size specifies the quantity needed.
\n[\n {\n \"recommendationType\": \"ub\",\n \"size\": 2\n },\n {\n \"recommendationType\": \"btb\",\n \"size\": 2\n },\n ...\n]\n\nThe sample below displays a request to the Mixed Strategy algorithm:
\nhttps://recommendation.api.useinsider.com/v2/mixed?locale={Locale}&partnerName={PartnerName}&strategy=[{\"recommendationType\":\"hdop\",\"size\":2}]\n\n{\n \"success\": true,\n \"total\": 2,\n \"types\": {\n \"hdop\": 2\n },\n \"data\": [\n \"XYZ-987789\",\n \"ABC-123321\"\n ]\n}\n\nFallback algorithms are determined by your strategy selections.
\n","urlObject":{"protocol":"https","path":["v2","mixed"],"host":["recommendation","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f433ab29-d1d6-4461-924b-c3e2b2dfdadc"},{"name":"Most Popular Items","id":"ad1756ce-6ea4-46ed-ab8d-111cfa639f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/most-popular","description":"The Most Popular Items algorithm recommends items by analyzing the most popular products by page views. It generates recommendations based on the page view counts during the last 30 days. The Most Popular Items algorithm works best on main, category, and product pages.
\nGET https://recommendation.api.useinsider.com/v2/most-popular
\nThe Most Popular Items algorithm also provides users with product recommendations based on their popularity within categories. To obtain category-based most popular products, the API endpoint should include the categoryList parameter with valid category values from the Product Catalog.
\nWhen categoryList is provided, recommendations are filtered to show only the Most Popular products within the specified categories. Recommendations served in the API response will be abbreviated as mvoc for Most Popular Items of Category recommendations.
\nThe sample below displays a request to Most Popular Items, an algorithm that recommends products with the highest overall engagement based on page views.
\nhttps://recommendation.api.useinsider.com/v2/most-popular?locale={Locale}&partnerName={PartnerName}\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mvop\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nhttps://recommendation.api.useinsider.com/v2/most-popular?locale={Locale}&partnerName={PartnerName}&categoryList=[“Dog Food”]\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mvoc\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nIf the products come from Most Popular Items are not enough to fill the response data, some fallback algorithms below fill it:
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/most-valuable","description":"The Most Valuable Products algorithm recommends items based on their contribution to total revenue. It recommends products that generate more revenue across your site. Products are recommended based on the contribution to revenue and revenue per visit. This type of algorithm can be used on all page types.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/most-valuable
\nThe sample below displays a request to Most Valuable Products, an algorithm that recommends items based on their contribution to total revenue:
\nhttps://recommendation.api.useinsider.com/v2/most-valuable?locale={Locale}¤cy={Currenct}&partnerName={PartnerName}\n\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"mpop\": 10\n },\n \"data\": [\n \"QAZ-7890\",\n \"XYZ-1234\",\n \"QAZ-7899\",\n \"XYZ-1233\",\n \"QAZ-7898\",\n \"XYZ-1243\",\n \"QAZ-7891\",\n \"XYZ-1223\",\n \"QAZ-7892\",\n \"XYZ-1342\"\n ]\n}\n\nIf the products from Most Valuable Products are not enough to fill the response data, some fallback algorithms below fill it:
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/new-arrivals","description":"The New Arrivals algorithm displays products that have been newly added to the website. It directly accesses the catalog and sorts products by creation date. Changing the integration type doesn't affect the results if the product is already in the database. You can use the New Arrivals algorithm on the main page to showcase new products.
\nFor the Publisher vertical, the updated time applies to newly released articles.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/new-arrivals
\nThe New Arrivals algorithm can also provide users with discounted product recommendations within the desired category.
\n\n\n
When categoryList is provided, only newly added products within the specified categories are recommended, ordered by publish date. Recommendations served in the API response will be abbreviated as naoc for the New Arrivals of Category recommendations.
\nThe sample below displays a request to New Arrivals, an algorithm that recommends products newly added to the website.
\nhttps://recommendation.api.useinsider.com/v2/new-arrivals?locale={Locale}&partnerName={PartnerName}\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"naop\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nhttps://recommendation.api.useinsider.com/v2/new-arrivals?locale={Locale}&partnerName={PartnerName}¤cy={Currency}&categoryList=[“Dog Food”]\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"naoc\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nIf the products from New Arrivals are not enough to fill the response data, some fallback algorithms below fill it:
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/purchased-together","description":"The Purchased Together algorithm recommends items by finding complementary products purchased by other users who have also purchased the user's items. It generates recommendations based on products purchased in the same sessions and in the same locale over the past 30 days. After generating recommendations, the Purchased Together algorithm orders the results according to purchase frequency. With the Purchased Together algorithm, you can apply your users' purchase patterns to your strategies. This type of algorithm works best on product and cart pages.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/purchased-together
\nWhen this algorithm is used on the cart page, its endpoint differs for multiple products. For example, three products (X, Y, Z) are in the cart. The recommendation API will return the complementary products for each product in the cart as X1, Y1, Z1, X2, Y2, Z2... respectively.
\nThe sample below displays a request to Purchased Together, an algorithm that recommends items frequently bought alongside the user’s selected product(s).
\nhttps://recommendation.api.useinsider.com/v2/purchased-together?partnerName={PartnerName}&locale={Locale}&productId={ProductId}\n\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"btb\": 10\n },\n \"data\": [\n \"QAZ-7890\",\n \"XYZ-1234\",\n \"QAZ-7899\",\n \"XYZ-1233\",\n \"QAZ-7898\",\n \"XYZ-1243\",\n \"QAZ-7891\",\n \"XYZ-1223\",\n \"QAZ-7892\",\n \"XYZ-1342\"\n ]\n}\n\nIf the products from Purchased Together are not enough to fill the response data, some fallback algorithms below fill it:
\nView Together
\nMost Purchased of the Category
\nMost Purchased of the Partner
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/last-purchased-together","description":"The Purchased with Last Purchased algorithm is one of Insider One's personalized algorithms. It recommends the purchased products along with the user’s last purchased product. Purchase events can be collected from Web, Mobile, and Offline (CRM) UCD events. It is available on Web Smart Recommender, API-based Recommender, and App Recommender.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/last-purchased-together
\nThe sample below displays a request to Purchased with Last Purchased, one of Insider One’s personalized recommendation algorithms.
\nhttps://recommendation.api.useinsider.com/v2/last=purchased-together?partnerName={PartnerName}&locale={Locale}&userId={UserId}\n\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"lpt\": 10\n },\n \"data\": [\n \"QAZ-7890\",\n \"XYZ-1234\",\n \"QAZ-7899\",\n \"XYZ-1233\",\n \"QAZ-7898\",\n \"XYZ-1243\",\n \"QAZ-7891\",\n \"XYZ-1223\",\n \"QAZ-7892\",\n \"XYZ-1342\"\n ]\n}\n\nBecause of its nature, the Purchased with Last Purchased Algorithm doesn’t have a fallback. However, you can always tune it by configuring the minimum number of products displayed in the Recommendation carousel under Recommendation Strategies.
\n","urlObject":{"protocol":"https","path":["v2","last-purchased-together"],"host":["recommendation","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"38785738-dfab-4ea3-ab11-8e15b32734b7"},{"name":"Recently Viewed Products","id":"c51542d8-99c9-45c4-b58e-e8260dbc7239","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/recently-viewed","description":"The Recently Viewed Products algorithm is one of Insider One's personalized algorithms. It tracks the user’s product-view behavior collected from the UCD, capturing data from both Web and Mobile events. In return, the Recently Viewed Products algorithm provides recommendations based on the user’s recently viewed products. It performs best on the cart pages. It is available on Web Smart Recommender, API-based Recommender, and App Recommender.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/recently-viewed
\nBecause of its nature, the Recently Viewed Algorithm doesn’t have a fallback. However, you can always tune it by configuring the minimum number of products displayed in the recommendation carousel in the Recommendation Strategies.
\n","urlObject":{"protocol":"https","path":["v2","recently-viewed"],"host":["recommendation","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c51542d8-99c9-45c4-b58e-e8260dbc7239"},{"name":"Substitute Products","id":"934103c4-fd03-49f7-a3cc-9865d3e98ca0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/substitute","description":"The Substitute Products algorithm provides users with suggestions for products that can serve as replacements for items they have interacted with. The goal is to enhance user satisfaction and engagement by presenting products that align with their functional preferences and interests. This algorithm generates recommendations based on factors such as product name similarity, view-to-view statistics, and view-to-purchase statistics.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/substitute
\nThe sample below displays a request to Substitute Recommendation, an algorithm that suggests alternative products to items a user has interacted with.
\nhttps://recommendation.api.useinsider.com/v2/substitute?partnerName={PartnerName}&locale={Locale}&productId={ABC123CBA}&size=5\n\n{\n \"success\": true,\n \"total\": 5,\n \"types\": {\n \"sp\": 5\n },\n \"data\": [\n \"ABC-123654\",\n \"ABC-123321\",\n \"ABC-123789\",\n \"ABC-123987\",\n \"ABC-123456\"\n ]\n}\n\nIf the products come from Substitute Products are not enough to fill the response data, some fallback algorithms below fill it:
\nViewed Together
\nMost Viewed of Category
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/top-sellers","description":"The Top Sellers algorithm recommends products based on their purchase counts over the last 30 days. It works best on the main page.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/top-sellers
\nThe Top Sellers algorithm also provides users with product recommendations based on categories and locations.
\nTo retrieve category-based best-selling products, the API endpoint should include the categoryList parameter with valid category values from the Product Catalog.
\nTo obtain the best-selling products based on location, country, and city information, the API endpoint should include these parameters.
\nPlease refer to the table below for the conditions and parameters to customize the Top Sellers algorithm.
\nWhen categoryList is provided, recommendations are filtered to show only the Top Seller products within the specified categories. Recommendations served in the API response will be abbreviated as mpoc for Top Sellers of Category recommendations.
\nWhen Top Sellers of Location recommendations are requested, the API endpoint will present recommendations with the mpol abbreviation.
\nThe sample below displays a request to Top Sellers, an algorithm that recommends products with the highest purchase counts over the last 30 days.
\nhttps://recommendation.api.useinsider.com/v2/top-sellers?locale={Locale}&partnerName={PartnerName}\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mpop\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nhttps://recommendation.api.useinsider.com/v2/most-popular?locale={Locale}&partnerName={PartnerName}¤cy={Currency}&categoryList=[“Dog Food”]\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mpoc\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nhttps://recommendation.api.useinsider.com/v2/most-popular?locale={Locale}&partnerName={PartnerName}¤cy={Currency}&country={country}&city={city}\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mpol\": 1\n },\n \"data\": [\n{\n \"image_url\": \"test.image_url.com\",\n \"name\": \"Original Air-dried Beef recipe for dogs\",\n \"item_id\": \"46177313784082\",\n \"url\": \"test.url.com\",\n \"description\": \"Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 29.58\n },\n \"groupcode\": \"8528988209426\",\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"activation_date\": \"2023-08-11\",\n \"shopify_tag\": [\n \"air-dried\",\n \"beef\",\n \"dog\"\n ]\n },\n \"stock_count\": 99,\n \"category\": [\n \"Dog Food\",\n \"Pets Collection\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 29.58\n }\n }\n ]\n}\n\nIf the products from Top Sellers are not enough to fill the response data, some fallback algorithms below fill it:
\nIf the city or country is given in as a query parameter, the fallback algorithms that fill it are:
\nMost purchased of the category
\nMost purchased of the category, without excluding the right-most item in the categoryList
\nMost purchased of the Partner
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/trending","description":"The Trending Products algorithm recommends items using a scoring system. It scores items based on weekly views and purchases to determine this week's trending items compared to those in the previous week. This type of algorithm works best on the main and category pages.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/trending
\nThe sample below displays a request to Trending Products, an algorithm that recommends items using a dynamic scoring system.
\nhttps://recommendation.api.useinsider.com/v2/trending?partnerName={partnerName}&locale={Locale}&size=2\n\n{\n \"success\": true,\n \"total\": 2,\n \"types\": {\n \"tpop\": 2\n },\n \"data\": [\n \"ASD-4983\",\n \"TYU-3451\"\n ]\n}\n\nIf the products from Trending Products are not enough to fill the response data, some fallback algorithms below fill it:
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/user-based","description":"The User Based algorithm recommends items by finding users similar to the current user. It generates recommendations based on user behavior and product popularity.
\nIn this algorithm, product recommendations are based on the behavior of similar users (users with close similarity index scores: viewed, purchased, or added the same or similar category products to their cart) with the current user. The algorithm recommends products that similar users have encountered in the past but that the current user has not visited. The user-based algorithm also takes the user-product-rating matrix as another input. For each product a user visits, a rating is calculated based on the number of visits, purchases, and add-to-carts within the last 30 days. This type of algorithm can be used on every kind of page.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/user-based
\nThe sample below displays a request to User Based, a personalized recommendation algorithm that finds users similar to the current user.
\nhttps://recommendation.api.useinsider.com/v2/user-based?partnerName={Partner_Name}&locale={Locale}¤cy=TRY&userId={User ID}\n\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"mvop\": 10\n },\n \"data\": [\n \"QAZ-7890\",\n \"XYZ-1234\",\n \"QAZ-7899\",\n \"XYZ-1233\",\n \"QAZ-7898\",\n \"XYZ-1243\",\n \"QAZ-7891\",\n \"XYZ-1223\",\n \"QAZ-7892\",\n \"XYZ-1342\"\n ]\n}\n\nIf the products come from User Based are not enough to fill the response data, some fallback algorithms below fill it:
\nView-to-view of the last visited product
\nMost viewed of the category
\nMost viewed of the category without excluding the right-most item in the categoryList
\nMost viewed of the Partner
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/user-engagement","description":"The User Engagement algorithm recommends products by analyzing the current user’s most recent interactions. It generates personalized recommendations based on real-time behaviors and evolving preferences.
\nThe User Engagement algorithm tailors product recommendations based on the user’s most recent product-view activity, using a deep-learning transformer model that dynamically adapts to recent interactions, such as viewing or purchasing patterns. It focuses specifically on items the user has shown interest in during recent sessions. During a Recommendation API request to the user-engagement endpoint, the UCD profile endpoint is called to retrieve the last 10 products the user visited in the past 7 days. To receive User Engagement recommendations, the user must have at least one product visit in the last 7 days. If there have been no visits in that period, fallback recommendation results will be displayed instead.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/user-engagement
\nThe sample below displays a request to User Engagement, a personalized recommendation algorithm that analyzes the current user’s most recent interactions (such as product views, clicks, or cart actions) to deliver highly relevant product suggestions in real time.
\nhttps://recommendation.api.useinsider.com/v2/user-engagement?locale={locale}&userId={userId}&partnerName={partnerName}\n\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"ue\": 10\n },\n \"data\": [\n \"649517_49890\",\n \"568334_49053\",\n \"639714_49677\",\n \"651579_3255\",\n \"614493_50094\",\n \"614508_49668\",\n \"568334_47380\",\n \"641331_49914\",\n \"621390_3255\",\n \"646581_48990\"\n ]\n}\n\nIf the current user has not visited two or more products, or if user engagement recommendations are filtered out, recommendations from the following algorithms are returned in sequence:
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"url":"https://recommendation.api.useinsider.com/v2/viewed-together","description":"The Viewed Together algorithm recommends items by identifying similar products users have viewed. It generates recommendations based on products viewed in the same sessions and in the same locale over the past 30 days. After generating recommendations, the Viewed Together algorithm orders the results by visit frequency (popularity). Thus, users can find complementary or substitute products for the one they are currently viewing. This increases discovery rates and the likelihood of grabbing users’ attention when they don’t have a target product. This type of algorithm works best on product pages.
\n\n\n
GET https://recommendation.api.useinsider.com/v2/viewed-together
\nThe sample below displays a request to Viewed Together, a recommendation algorithm that suggests items commonly viewed alongside the same product by other users.
\nhttps://recommendation.api.useinsider.com/v2/viewed-together?locale={Locale}&productId={ProductID}¤cy={Currenct}&partnerName={PartnerName}\n\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"mvop\": 10\n },\n \"data\": [\n \"QAZ-7890\",\n \"XYZ-1234\",\n \"QAZ-7899\",\n \"XYZ-1233\",\n \"QAZ-7898\",\n \"XYZ-1243\",\n \"QAZ-7891\",\n \"XYZ-1223\",\n \"QAZ-7892\",\n \"XYZ-1342\"\n ]\n}\n\nIf the products from Viewed Together are not enough to fill the response data, some fallback algorithms below fill it:
\nMost viewed of the category
\nMost viewed of the category without excluding the right-most item in the categoryList
\nMost viewed of the Partner
\nThe main recommendation algorithms available through the Recommendation API are categorized by type and methodology. Each algorithm can be called via its dedicated endpoint.
\n","_postman_id":"21dadeed-ce2b-44db-9ee1-33948e46d5c7"},{"name":"Get Recommendations","id":"d63e7967-0902-47e1-802d-a586f2e913f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-REQUEST-TOKEN","value":"1a2b3c4d5e6f","description":"Your API authentication token
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://recommendation.api.useinsider.com/v2/{algorithm-name}","description":"The Recommendation API (SR-API) is a RESTful service for programmatically retrieving personalized product suggestions. It serves as the interface to Insider One’s recommendation engine, utilizing machine learning models, real-time user behavior analysis, and product affinity data to return structured item sets.
\nThe Recommendation API follows a standard RESTful pattern:
\nGET https://recommendation.api.useinsider.com/v2/{algorithm-name}
\n{algorithm-name} is the unique identifier for the recommendation logic to be executed.
\nExamples:
\n/v2/most-popular - Most viewed products
\n/v2/user-based - Personalized user recommendations
\n/v2/purchased-together - Frequently bought together items
\nRefer to Algorithm Descriptions for the full list.
\nBefore making your first request, you'll need:
\nAll requests require your API token in the request header.
\nPartner ID/Name - Your store identifier
\nLocale - Language and region code used for recommendation context (e.g., en_US, fr_FR)
\nCurrency - Currency code (e.g., USD, EUR)
\nEach algorithm has a short abbreviation used in response payloads:
\nmvop = Most Popular Items
\nub = User Based
\nbtb = Purchased Together
\nchef = Chef (automated strategy selector)
\nRefer to the Algorithm Descriptions for the complete list.
\nAll endpoints support common parameters:
\ncurl -X GET \"https://recommendation.api.useinsider.com/v2/most-popular?partnerName=dataforceapi&locale=tr_TR&size=1&details=true\" \\\n -H \"X-Auth-Token: YOUR_API_TOKEN\"\n\nconst apiToken = 'YOUR_API_TOKEN';\n const endpoint = 'https://recommendation.api.useinsider.com/v2/most-popular';\n const params = {\n partnerName: 'yourPartnerName',\n locale: 'tr_TR',\n size: 1,\n details: true\n };\n const queryString = new URLSearchParams(params).toString();\n fetch(`${endpoint}?${queryString}`, {\n method: 'GET',\n headers: {\n 'X-Auth-Token': apiToken\n }\n })\n .then(response => response.json())\n\nimport requests\n api_token = 'YOUR_API_TOKEN'\n endpoint = 'https://recommendation.api.useinsider.com/v2/most-popular'\n params = {\n 'partnerName': 'yourPartnerName',\n 'locale': 'tr_TR',\n 'size': 1,\n 'details': True\n }\n headers = {\n 'X-Auth-Token': api_token\n }\n response = requests.get(endpoint, params=params, headers=headers)\n data = response.json()\n print(data)\n\nResponses follow a consistent JSON structure:
\n{\n \"success\": true,\n \"total\": 10,\n \"types\": {\n \"mvop\": 10\n },\n \"data\": [\"productId1\", \"productId2\", ...]\n }\n\n\n\n<p >With details=true, the data array contains full product objects including pricing, images, categories, and attributes.</p>
\n
A successful response looks like this:
\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mvop\": 1\n },\n \"data\": [\"SKU-DK-0011\"]\n }\n\nBy default, the API returns only product IDs. To get full product information (images, prices, descriptions), add details=true.
\ncurl -X GET \"https://recommendation.api.useinsider.com/v2/most-popular?partnerName=yourpartnername&locale=tr_TR&size=1&details=true\" \\\n -H \"X-Auth-Token: YOUR_API_TOKEN\"\n\nconst params = {\n partnerName: 'yourpartnername',\n locale: 'tr_TR',\n size: 1,\n details: true\n };\n\nparams = {\n 'partnerName': 'yourpartnername',\n 'locale': 'tr_TR',\n 'size': 1,\n 'details': True\n }\n\nResponse with details=true includes:
\nimage_url - Product image
\nname - Product name
\nprice - Product pricing (by currency)
\ncategory - Product categories
\ndiscount - Discount information
\nin_stock - Stock status
\nHere is a full example with details=true:
\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mvop\": 1\n },\n \"data\": [\n {\n \"item_id\": \"SKU-HA-0011\",\n \"name\": \"Hummingbird Decorative Cushion\",\n \"locale\": \"en_US\",\n \"image_url\": \"https://cdn.demo-shop.com/images/home-accessories/hummingbird-cushion-45x45.jpg\",\n \"url\": \"https://www.demo-shop.com/en/home-accessories/hummingbird-decorative-cushion?ins_sr=eyJwcm9kdWN0SWQiOiJTS1UtSEEtMDAxMSJ9\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 24.99\n },\n \"original_price\": {\n \"USD\": 29.99\n },\n \"discount\": {\n \"USD\": 5.0\n },\n \"category\": [\n \"Home Accessories\",\n \"Decorative Cushions\"\n ],\n \"description\": \"Soft cotton decorative cushion with hummingbird pattern. Ideal for living rooms and bedrooms.\",\n \"brand\": \"Demo Home\",\n \"color\": \"Multicolor\",\n \"size\": \"45x45 cm\",\n \"tags\": [\n \"cushion\",\n \"home-decor\",\n \"living-room\"\n ],\n \"material_type\": \"Cotton\",\n \"washable\": \"Yes\",\n \"room\": \"Living Room\"\n }\n ]\n }\n\nThe following table demonstrates the status codes and response types from the Recommendation API. The table lists Status Codes, their descriptions, and scenarios that you can receive these status codes.
\nSuccessful Recommendation API requests receive an API endpoint that contains the following fields:
\nsuccess field that denotes the success of the API response,
\ntotal field displays the number of recommendations returned from the API response,
\ntypes field that lists recommendation algorithm types that returned from the endpoint,
\ndata field lists the recommendations and their details
\nFollowing is a successful Recommendation API request and its example response:
\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true&partnerName=yourPartnerName&locale=en_US¤cy=USD&size=1\n\n{\n \"success\": true,\n \"total\": 1,\n \"types\": {\n \"mvop\": 1\n },\n \"data\": [\n {\n \"image_url\": \"http://insiderone.com/img/p/1/3/13.jpg\",\n \"name\": \"Hummingbird cushion\",\n \"item_id\": \"11\",\n \"url\": \"https://insiderone.com/home-accessories/11-hummingbird-cushion.html#ins_sr=eyJwcm9kdWN0SWQiOiIxMSJ9\",\n \"description\": \"Hummingbird cushion in category Home Accessories\",\n \"in_stock\": 1,\n \"price\": {\n \"USD\": 0.57\n },\n \"locale\": \"en_US\",\n \"product_attributes\": {\n \"test\": \"productTest\",\n \"testattributes\": \"productTest\"\n },\n \"category\": [\n \"Home Accessories\"\n ],\n \"discount\": {\n \"USD\": 0.0\n },\n \"original_price\": {\n \"USD\": 0.57\n }\n }\n ]\n}\n\nIn the following scenarios, the Recommendation API returns responses with a 400 status code:
\nMissing required endpoint parameters
\nMissing required endpoint parameter values
\nWrong usage of endpoint parameters
\nFollowing API requests and responses demonstrate examples of these scenarios.
\nThe partnerName parameter is missing in the request below:
\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true¤cy=USD&locale=en_US\n\n{\n \"success\": false,\n \"message\": \"Missing parameter: partnerName\",\n \"data\": []\n}\n\nThe locale value is missing in the request below:
\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true¤cy=USD&locale=&partnerName=yourPartnerName\n\n{\n \"success\": false,\n \"message\": \"Locale is invalid.\",\n \"data\": []\n}\n\nThe Recommendation API performs sender origin validation for partners that enable the Origin/CORS Validation feature. When the feature is enabled, the Recommendation API only provides successful recommendation content to callers from the allowed domains. Requests from domains that are not listed as allowed domains will receive failures with a 403 status code.
\nFollowing is the Recommendation API response for unsuccessful validations:
\n{\n \"success\": false,\n \"message\": \"Origin validation error.\",\n \"data\": []\n}\n\nThis endpoint response status code is often received when the partner page that hosts the recommendation campaign cannot provide the details that the Recommendation API endpoint needs to use.
\nAs an example scenario;
\nYou create and activate a Web Smart Recommender campaign on Product Pages that has Dynamic Filtering usage on the color field.
\nIn Dynamic Filtering, the attribute values of fields used in filters are fetched from the Recommendation API.
\nThus, web clients are not informed whether the requested attribute is present for the current product.
\nIn cases where the attribute value that is used in the Dynamic Filter is missing, the Recommendation API cannot perform the Dynamic Filter.
\nThe API returns with a 422 status code for those cases.
\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true&filter=([color][=][${value}])¤cy=TRY&locale=tr_TR&partnerName=yourPartnerName&productId=11\n\nThe color attribute was missing for the given item with ID “11”. When this attribute is requested with dynamic filtering, the Recommendation API responds with a 422 status code (denoting that an unprocessible content is present)
\n{\n \"success\": false,\n \"message\": \"The field 'color' in dynamic filter was not found in the product.\",\n \"data\": []\n}\n\nWhen you exceed the rate limit, the Recommendation API will temporarily throttle your requests. Rate limits are calculated using a rolling one-minute window, so if you're throttled, you'll regain access once the current window resets (at most one minute).
\n{\n \"success\": false,\n \"message\": \"Rate exceeded.\",\n \"data\": []\n}\n\nFiltering allows you to refine recommendation results to match your users' needs and preferences. Common use cases include:
\nExclude already-viewed products - Don't recommend products the user has seen
\nPrice range filtering - Show only products within budget
\nCategory/brand filtering - Focus on specific product types
\nStock filtering - Only recommend in-stock items
\nAttribute filtering - Filter by custom product attributes (color, size, rating, etc.)
\nThis increases relevance, improves user experience, and boosts conversion rates.
\nhttps://recommendation.api.useinsider.com/v2/{algorithm}?...\\&filter=[{field}][{operator}][{value}]\n\nHere is an example with a single filter that returns products with prices greater than 100 USD:
\n?filter=[price.USD][>][100]\n\nYou can pass multiple filter parameters to combine conditions. Each condition is chained together via an asterisk (*).
\n?filter=[field1][operator1][value1]*[field2][operator2][value2]\n\nMultiple filters are combined with AND logic - products must match ALL conditions to be included.
\n?filter=[item_id][!=][PRODUCT_ID]*[category][~][Shoes]\n\nThis filter returns products that are NOT PRODUCT_ID AND contain \"Shoes\" in the category.
\n?filter=[price.USD][>][50]*[price.USD][<][200]*[in_stock][=][1]\n\nThis filter returns products between $50-$200 AND in stock.
\nInsider One is designed to parse every filter value provided for date fields. If a simplified date expression fails to parse, the system will use it as a raw literal value. This allows you to use literal dates (e.g., \"2022-09-30 15:45:00\") directly in your date filters.
\nThe date fields available for filtering are: created_at and modified_at.
\nDate fields are supported by every operator except for Between (><) and Not Between (>!<). This limitation is due to the Between operator using a colon (:) to separate the lower and upper bounds, which conflicts with the colon present in standard date/time formats (e.g., 2022-09-30 15:45:00).
\nThe most appropriate operators for date fields are:
\nAfter (>)
\nBefore (<)
\nIs (=)
\nIs Not (!=)
\nDate filters also support relative unit values, allowing you to easily filter based on time relative to the current moment (now).
\nAnchor: now
\nUnits: w (week), d (day), h (hour)
\nModifiers: Use + to add units or - to subtract units.
\nYou can see the examples below:
\nMatch fields against multiple values by separating them with:
\n||\n\nSupported by all operators except between and not between.
\nExamples:
\n?filter=[brand][=][Niki||Abiba||Pamu]\n\n?filter=[color][!=][Red||Green||Blue]\n\nGet products with categories containing any of these terms:
\n?filter=[category][~][Shoes||Boots||Sneakers]\n\nCombine multiple filters using logical operators within a single filter parameter.
\nAnd (*) = both conditions must be true
\nOr (|) = either condition can be true
\n?filter=([price.USD][>][100]*[brand][=][Niki]) \n\n?filter=([category][~][Shoes]|[category][~][Boots])\n\nGet products that are either (cheap AND in stock) OR highly rated:
\n?filter=((price.USD][<][50]*[in_stock][=][1])|[rating][>=][5])\n\n\n\n
You can also use multiple parameters to achieve AND logic more simply:
\n?filter=[price.USD][<][50]&filter=[in_stock][=][1]&filter=[rating][>=][5]\n\nThis is often clearer than using complex parentheses.
\nUse ${value} to reference the source product's field value in your filter. The expression is computed at request time using the actual product data.
\nSupported Expressions
\n${value} - Use the product's field value as-is
\n${value*1.2} - Multiply by 1.2 (20% increase)
\n${value*0.8} - Multiply by 0.8 (20% decrease)
\n${value*0.8}:${value*1.3} - Range with dynamic bounds
\n?categoryList=${value}&productId=PRODUCT_ID\n\nIf the product has a category \"Shoes\", recommendations are filtered to \"Shoes\" only.
\n?productId=PRODUCT_ID&filter=[price.EUR][><][${value}:${value*1.3}]\n\nIf the product costs €100, it shows products priced €100-€130.
\nWhen filters are invalid, the API returns specific error messages with HTTP status codes:
\nThe Recommendation API provides a range of personalization capabilities that tailor product recommendations to individual users. By leveraging user behavior, such as browsing history, purchase activity, and real-time interactions, the API delivers more relevant product suggestions that increase engagement and conversion rates.
\nTo enable personalization, you must include the Insider ID in your Recommendation API requests. This allows the system to associate incoming requests with existing user profiles and apply behavior-driven logic.
\nCurrently, the Recommendation API supports the following personalization features:
\nThe following recommendation algorithms inherently deliver personalized product suggestions based on user behavior and interaction data.
\nGenerate personalized recommendations by analyzing a user’s historical interactions and the behavior patterns of similar users.
\nProvide real-time personalized suggestions based on the user’s current session activity and live interactions.
\nRecommend products based on the user’s most recent product page views, helping reinforce recent browsing intent.
\nSuggest products that are frequently purchased together with the user’s most recent purchase, supporting effective cross-sell scenarios.
\nThese algorithms leverage both historical and real-time data to ensure recommendations remain relevant, timely, and aligned with individual user preferences.
\nThe Recommendation API can personalize results using the last product page a user visited. This behavior applies to both User-Based Recommendations and Real-Time User Engagement algorithms.
\nWhen the API does not have sufficient user-level data to generate a fully personalized recommendation, it automatically falls back to Viewed Together recommendations based on the user’s most recently viewed product.
\nThis fallback mechanism ensures that recommendations remain relevant and context-aware, even when historical user data is limited.
\nThe Recommendation API can automatically exclude products a user has already interacted with, so they won't see recommendations for items they've viewed, purchased, or otherwise engaged with.
\nUse the following parameters to enable these exclusions:
\nThe following Recommendation API requests illustrate these personalization features:
\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true¤cy=TRY&locale=tr_TR&partnerName=dataforceapi&userId=testUser&excludeViewItem=10\n\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true¤cy=TRY&locale=tr_TR&partnerName=dataforceapi&userId=testUser&excludePurchaseDay=3\n\nAttribute affinity scores represent a user’s preference for specific product attributes based on their interaction behavior, including product views, add-to-cart actions, and purchases. Purchases carry a higher weight than views, as they indicate stronger intent. Affinity scores are normalized by a user’s total activity. As a result, a user with a high purchase-to-view ratio demonstrates a stronger affinity than a user who browses frequently but converts rarely.
\nThe Recommendation API uses attribute affinity to personalize product recommendations according to each user’s demonstrated interests. Affinity data is refreshed daily, ensuring recommendations reflect recent and relevant user behavior.
\nWithin the Recommendation API, the hp endpoint parameter controls whether the Attribute Affinity feature is applied. When enabled, the API incorporates a user’s attribute affinity scores into the recommendation logic, prioritizing products that align with the user’s strongest preferences.
\nThe following Recommendation API request demonstrates how the Attribute Affinity feature is applied when the hp parameter is enabled:
\nhttps://recommendationv2.api.useinsider.com/v2/most-popular?details=true¤cy=TRY&locale=tr_TR&partnerName=yourPartnerName&userId=testUser&hp=1\n\nThe rate limit for direct API calls is set to 1000 calls per minute, applied across all endpoints of the Recommendation API. Exceeding this rate limit causes additional requests to return 429 status codes.
\n\n\n<p >If your technical architecture requires a higher throughput, contact the Insider One team.</p>
\n
When filtering by categories, pass categoryList as a URL-encoded JSON array:
\ncategoryList=[\"shoes\",\"boots\"]\n\nIn cURL, encode the brackets properly:
\n?categoryList=[\"shoes\",\"boots\"]\n\nEnable hyperpersonalization by adding hp=1 or hp=true:
\n?userId=user123&hp=1\n\nThis uses customer affinities to further personalize results.
\nCombine multiple recommendation algorithms in a single request to get diverse results.
\nGET /mixed?partnerName=X&locale=en_US&userId=user1¤cy=USD&strategy=[...]\n\n[\n {\"recommendationType\": \"ub\", \"size\": 4},\n {\"recommendationType\": \"vtv\", \"size\": 3, \"productId\": \"prod1\"},\n {\"recommendationType\": \"mvop\", \"size\": 3, \"filters\": [\"\\[category\\]\\[=\\]\\[shoes\\]\"]}\n]\n\nAvailable types: ub, ue, vtv, btb, cp, sp, mvoc, mvop, mpoc, mpop, mpol, naoc, naop, tpoc, tpop, mvpoc, mvpop, mm, hdop, hdoc, rvp, lpt
\nEach strategy specifies its algorithm type, the number of products to return, and, optionally, its own filters.
\nUse mm to include specific products you want to promote. The productId field is required.
\n{\"recommendationType\": \"mm\", \"size\": 3, \"productId\": \"featured1,featured2,featured3\"}\n\nFull example:
\nGET /mixed?partnerName=X&locale=en_US¤cy=TRY&strategy=[{\"recommendationType\":\"ub\",\"size\":5},{\"recommendationType\":\"mm\",\"size\":3,\"productId\":\"promo1,promo2,promo3\"},{\"recommendationType\":\"mvop\",\"size\":2}]\n\nPass product IDs as comma-separated values.
\nProducts are returned in the order you specify.
\nOnly in-stock products are returned.
\nGet recommendations based on multiple products at once by passing comma-separated IDs:
\nGET /vtv?partnerName=X&locale=en_US&productId=item1,item2,item3&size=10¤cy=USD\n\nSupported endpoints are /vtv, /btb, /cp, /sp. It is useful when you want recommendations based on multiple items in a cart or wishlist.
\nInclude product variants (e.g., different sizes/colors) in the response using getGroupProducts.
\nGET /ub?partnerName=X&locale=en_US&userId=user1&getGroupProducts=true&groupProductsFields=price,in_stock,product_attributes.color\n\ngetGroupProducts=true — Enable variant products in response
\ngroupProductsFields — Additional fields to include (comma-separated)
\n{\n \"item_id\": \"shoe-blue-m\",\n \"group_products\": [\n {\"item_id\": \"shoe-blue-s\", \"price\": {\"USD\": 99}, \"in_stock\": 1},\n {\"item_id\": \"shoe-blue-l\", \"price\": {\"USD\": 99}, \"in_stock\": 1}\n ]\n}\n\nVariants are grouped by groupcode. You can request nested fields, such as product_attributes.color.
\nTo combine multiple filters with AND logic, use *. Here is an example of applying multiple filters:
\nGET \n...&filter=[category][=][shoes]*[brand][=][nike]*[price][<][100]\n\nThe Event Collection API allows you to integrate user event collection functionality into Eureka. The API is designed to collect user events such as search queries, clicks, add to carts, and purchases. You can use the collected data to improve Eureka’s performance and user experience.
\nThe search event should be fired when a visitor makes a search for a product or content.
\nIt is recommended to send the search event with each request unless you are using Eureka in a search-as-you-type experience.
\nIf you are using search-as-you-type, the search event should be sent after the user completes their discovery, such as when they click on a product or navigate to another page.
\nIf the user stops typing and does not interact with facets, sorting, or pagination, you may assume the query is complete and trigger the search event. A 10-second waiting time is recommended to determine when the user has paused long enough to consider the search finalized.
\nPOST https://eurekaevent.api.useinsider.com/api/v1/events
\nThe search event supports the following properties:
\nIf your integration was implemented before the Advanced Analytics September 01, 2025, release, please be aware that new fields have been added to the expected product payload structure. You are required to review and implement these additions to ensure more comprehensive and accurate analytics.
\nYou can view the differences in the updated payload structure in the Common Properties.
\nFor the same traceId, a product must be sent only once. Even if the user interacts with sorting, pagination, or facet filters, the same product should not be sent again within the same session. Sending the product once under the same traceId is sufficient.
\nExample Conceptual flow
\nUser submits a search query
\nExample: query = \"myphone\"
\nGenerated traceId = \"x123\" for this search session.
\nFirst response is returned
\nProducts:myiphone 11, myphone 12, myphone 13
\nTracking layer checks: “Have I already sent myphone 11, myphone 12, or myphone 13 for traceId = x123?”
\nSend only new products to tracking
\nInitially, nothing has been sent yet, so:
\nSend myphone 11, myphone 12, myphone 13
\nMark them as seen for x123.
\nUser changes sorting / goes to next page / applies a filter
\nUnder the same traceId = x123.
\nSome products may repeat and some may be new (e.g. myphone X, myphone 17).
\nBefore sending events, filter out already-seen products
\nCompare the new product list with the set {myphone 11, myphone 12, myphone 13} already sent for x123.
\nOnly send tracking events for products not in that set.
\nTo ensure accurate and efficient search event tracking, the following recommendations should be applied:
\nEach time the user types in the search input or interacts with filters (such as sorting, pagination, or facets) within the search popup, a 10-second timer is triggered.
\nIf the user performs another action before the 10 seconds elapse, the timer is reset.
\nIf no interactions occur within 10 seconds, the search event log is sent.
\nA search event should also be sent in the following situations if it has not already been logged:
\nWhen the user clicks a product and navigates to the product page
\nOn exit intent, if the log has not yet been sent
\nWhen a product is added to the cart
\nWhen the user deletes the entire query (send for the previous query if not yet logged)
\nWhen the user copies and pastes a new query (send for the previous query if not yet logged)
\nWhen the user modifies the query after applying a facet (send for the previous query if not yet logged)
\nThese recommendations ensure that search events are captured reliably without duplication, providing more accurate insights into user behavior.
\nTo gain a deeper understanding, check out the details on facet and product fields on the Common Properties page.
\n\n\n<p >Please note that the following user actions are also considered search requests:</p><p >- Changing the sorting option</p><p >- Applying a facet filter</p><p >- Pagination</p>
\n
In the example below, you see a sample request along with guidance on modifying the necessary fields. This will help you seamlessly integrate and make the most of the provided configuration.
\nBefore usage, modifying the values such as x-auth-token and x-partner-config-key is essential.
\ncurl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \\\n--header 'x-auth-token: YOUR_AUTH_TOKEN' \\\n--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"referrer\": \"https://example.com/homepage\",\n \"source\": \"search-listing\",\n \"userId\": \"user-12345\",\n \"platform\": \"desktop-web\",\n \"campId\": 999999,\n \"variationId\": 999999,\n \"query\": \"laptop\",\n \"traceId\": \"search-traceId-abc123\",\n \"strategyId\":\"strategy-id-123\",\n \"sessionId\":\"session-id-123\",\n \"resultCount\": 25,\n \"itemsPerPage\": 10,\n \"totalPages\": 3,\n \"currentPage\": 1,\n \"sorting\": \"Relevancy\",\n \"facets\": [\n {\n \"label\": \"Price\",\n \"field\": \"price_en\",\n \"values\": [\"500\", \"2000\"]\n },\n {\n \"label\": \"Brand\",\n \"field\": \"brand_en\",\n \"values\": [\"Pear\", \"Deli\", \"SP\"]\n }\n ],\n \"products\": [\n {\n \"id\": \"product-001\",\n \"groupCode\": \"laptop-group-1\",\n \"price\": 1299.99,\n \"convertedPrice\": 1199.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"displayPosition\": 1\n },\n {\n \"id\": \"product-002\",\n \"groupCode\": \"laptop-group-2\",\n \"price\": 899.99,\n \"convertedPrice\": 829.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"displayPosition\": 2\n }\n ],\n \"eventType\": \"search\",\n \"integrationType\": \"web\",\n \"createdAt\": \"2025-11-25T10:30:00Z\"\n}'\n\nRequired. Source URL of the referring page.
\n","type":"text/plain"},"key":"referrer","value":"String"},{"disabled":true,"description":{"content":"Campaign ID, provided in the Insider's InOne panel.
\n","type":"text/plain"},"key":"campId","value":"Integer"},{"disabled":true,"description":{"content":"Variation ID, provided in the Insider's InOne panel
\n","type":"text/plain"},"key":"variationId","value":"Integer"},{"disabled":true,"description":{"content":"oneof= - search-popup - search-listing
\n","type":"text/plain"},"key":"source","value":"String"},{"disabled":true,"description":{"content":"Required. Platform used by the user.
\n","type":"text/plain"},"key":"platform","value":"String"},{"disabled":true,"description":{"content":"Required, oneof= api - web
\n","type":"text/plain"},"key":"integrationType","value":"String"},{"disabled":true,"description":{"content":"Required. Unique trace identifier created for the current query.
\n","type":"text/plain"},"key":"traceId","value":"String"},{"disabled":true,"description":{"content":"Browser/app session identifier
\n","type":"text/plain"},"key":"sessionId","value":"String"},{"disabled":true,"description":{"content":"Optional strategy identifier
\n","type":"text/plain"},"key":"strategyId","value":"String"},{"disabled":true,"description":{"content":"Required. Unique identifier of the user.
\n","type":"text/plain"},"key":"userId","value":"String"},{"disabled":true,"description":{"content":"Required. Query the user searched with.
\n","type":"text/plain"},"key":"query","value":"String"},{"disabled":true,"description":{"content":"Required unless no result, min=1. Number of search results returned.
\n","type":"text/plain"},"key":"resultCount","value":"String"},{"disabled":true,"description":{"content":"Required unless no result, min=1. Number of items per page used in search request.
\n","type":"text/plain"},"key":"itemsPerPage","value":"Integer"},{"disabled":true,"description":{"content":"Required unless no result, min=1. Total number of pages returned by search.
\n","type":"text/plain"},"key":"totalPages","value":"Integer"},{"disabled":true,"description":{"content":"Required unless no result, min=1. Page number where the search results displayed.
\n","type":"text/plain"},"key":"currentPage","value":"Integer"},{"disabled":true,"description":{"content":"Required. Sorting method used in search request. It is the type of sorting object of search response.
\n","type":"text/plain"},"key":"sorting","value":"String"},{"disabled":true,"description":{"content":"List of facets of the search. Required if any facet selected.
\n","type":"text/plain"},"key":"facets","value":"List of facets"},{"disabled":true,"description":{"content":"List of products returned by the search. Required unless no result.
\n","type":"text/plain"},"key":"products","value":"List of products"},{"disabled":true,"description":{"content":"Required, equals=search. Type of event.
\n","type":"text/plain"},"key":"eventType","value":"String"},{"disabled":true,"description":{"content":"Required. Time when the event is created.
\n","type":"text/plain"},"key":"createdAt","value":"String"}],"variable":[]}},"response":[],"_postman_id":"e8b5bdfd-6aa5-48df-906f-c34964b546ee"},{"name":"Collect user's product click event","id":"b6922c79-7230-4271-b802-96d1e7fa4fec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://eurekaevent.api.useinsider.com/api/v1/events","description":"The Event Collection API allows you to integrate user event collection functionality into Eureka. The API is designed to collect user events such as search queries, clicks, add to carts, and purchases. You can use the collected data to improve Eureka’s performance and user experience.
\nThe product click event should be triggered whenever a visitor clicks an item from the search results.
\nA product click event should be sent in the following situations:
\nWhen an item is clicked from the search popup, listing page, or any other search result surface.
\nWhen a user adds a product to the cart directly from the pop-up, without visiting the Product Detail Page (PDP):
\nPOST https://eurekaevent.api.useinsider.com/api/v1/events
\nThe product click event supports the following properties:
\nIf your integration was implemented before the Advanced Analytics September 01, 2025, release, please note that new fields have been added to the expected product payload. Following this release, the event now retrieves currentPage and related details from product-level fields instead of top-level fields. In addition, the product object has been enriched with several new fields.
\nFor backward compatibility, you may continue sending these values at the event level. However, it is strongly recommended to update your implementation to the new product-level structure to ensure full alignment with the latest version and to benefit from more comprehensive analytics.
\nYou can review the full list of changes on the Common Properties page.
\nIn the example below, you see a sample request along with guidance on modifying the necessary fields. This will help you seamlessly integrate and make the most of the provided configuration.
\nBefore usage, it is essential to modify the values such as x-auth-token and x-partner-config-key.
\ncurl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \\\n--header 'x-auth-token: YOUR_AUTH_TOKEN' \\\n--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"referrer\": \"https://example.com/search-results\",\n \"source\": \"search-listing\",\n \"userId\": \"user-12345\",\n \"platform\": \"mobile-web\",\n \"campId\": 100,\n \"variationId\": 200,\n \"product\": {\n \"id\": \"product-001\",\n \"groupCode\": \"laptop-group-1\",\n \"query\": \"laptop\",\n \"price\": 1299.99,\n \"convertedPrice\": 1199.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"clickPosition\": 3,\n \"displayPosition\": 3,\n \"quantity\": 1,\n \"resultCount\": 25,\n \"itemsPerPage\": 10,\n \"totalPages\": 3,\n \"facets\": [\n {\n \"label\": \"Fiyat\",\n \"field\": \"price\",\n \"values\": [\"500\", \"2000\"]\n }\n ],\n \"sorting\": \"PriceAsc\",\n \"currentPage\": 1,\n \"traceId\": \"search-session-abc123\",\n \"strategyId\":\"strategy-id-123\",\n \"sessionId\":\"session-id-123\"\n },\n \"eventType\": \"product-click\",\n \"integrationType\": \"web\",\n \"createdAt\": \"2025-11-25T10:35:00Z\"\n}'\n\nRequired. Source URL of the referring page.
\n","type":"text/plain"},"key":"referrer","value":"String"},{"disabled":true,"description":{"content":"Campaign ID, provided in the Insider's InOne panel.
\n","type":"text/plain"},"key":"campId","value":"Integer"},{"disabled":true,"description":{"content":"Variation ID, provided in the Insider's InOne panel
\n","type":"text/plain"},"key":"variationId","value":"Integer"},{"disabled":true,"description":{"content":"Source origin where the event triggered
\n","type":"text/plain"},"key":"source","value":"String"},{"disabled":true,"description":{"content":"Required. Type of integration.
\n","type":"text/plain"},"key":"integrationType","value":"String"},{"disabled":true,"description":{"content":"Required. Platform used by the user.
\n","type":"text/plain"},"key":"platform","value":"String"},{"disabled":true,"description":{"content":"Required. Unique identifier of the user.
\n","type":"text/plain"},"key":"userId","value":"String"},{"disabled":true,"description":{"content":"Required. The product clicked by the user.
\n","type":"text/plain"},"key":"product","value":"List of product"},{"disabled":true,"description":{"content":"Required, equals=search. Type of event.
\n","type":"text/plain"},"key":"eventType","value":"String"},{"disabled":true,"description":{"content":"Required. Time when the event is created.
\n","type":"text/plain"},"key":"createdAt","value":"String"}],"variable":[]}},"response":[],"_postman_id":"b6922c79-7230-4271-b802-96d1e7fa4fec"},{"name":"Collect user's product list view event","id":"68b3a9d0-5ab5-47a0-8d1f-656873672db6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://eurekaevent.api.useinsider.com/api/v1/events","description":"The Event Collection API allows you to integrate user event collection functionality into Eureka. The API is designed to collect user events such as search queries, clicks, add to carts, and purchases. You can use the collected data to improve Eureka’s performance and user experience.
\nThe product list view event should be fired when a visitor views a category or brand listing page that displays products. This event is used to track impressions on non-search listing pages, such as category and brand pages.
\nSuggested cases are as follows;
\nWhen a user visits a category listing page (e.g., Electronics > Laptops)
\nWhen a user applies filters, changes sorting, or navigates tothe next page within a category listing
\nPOST https://eurekaevent.api.useinsider.com/api/v1/events
\nThe Product List View event supports the following properties:
\n\n\n<p >Each list page request is assigned a uniquely generated traceId.</p>
\n
In the examples below, we provide sample requests along with guidance on modifying the necessary fields. This will help you seamlessly integrate and make the most of the provided configuration.
\n\n\n
Before usage, modifying the values such as x-auth-token and x-partner-config-key is essential.
\ncurl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \\\n--header 'x-auth-token: YOUR_AUTH_TOKEN' \\\n--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"referrer\": \"https://example.com/category/electronics\",\n \"source\": \"category-listing\",\n \"listValue\": \"electronics~laptops\",\n \"userId\": \"user-12345\",\n \"platform\": \"desktop-web\",\n \"traceId\": \"trace-abc123\",\n \"sessionId\": \"session-abc123\",\n \"strategyId\": \"strategy-001\",\n \"sorting\": \"PriceAsc\",\n \"resultCount\": 120,\n \"itemsPerPage\": 24,\n \"totalPages\": 5,\n \"currentPage\": 1,\n \"integrationType\": \"api\",\n \"createdAt\": \"2026-01-20T14:30:00Z\",\n \"facets\": [\n {\n \"label\": \"Brand\",\n \"field\": \"brand_en\",\n \"values\": [\"Apple\", \"Dell\"]\n }\n ],\n \"products\": [\n {\n \"id\": \"product-001\",\n \"groupCode\": \"laptop-group-1\",\n \"price\": 999.99,\n \"convertedPrice\": 949.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"position\": 1,\n \"displayPosition\": 1,\n \"isMerchandisedItem\": false\n },\n {\n \"id\": \"product-002\",\n \"groupCode\": \"laptop-group-2\",\n \"price\": 1299.99,\n \"convertedPrice\": 1249.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"position\": 2,\n \"displayPosition\": 2,\n \"isMerchandisedItem\": false\n }\n ],\n \"eventType\": \"product-list-view\"\n}'\n\ncurl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \\\n--header 'x-auth-token: YOUR_AUTH_TOKEN' \\\n--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"referrer\": \"https://example.com/category/electronics\",\n \"source\": \"category-listing\",\n \"listValue\": \"samsung laptops\",\n \"userId\": \"user-12345\",\n \"platform\": \"desktop-web\",\n \"traceId\": \"trace-abc123\",\n \"sessionId\": \"session-abc123\",\n \"strategyId\": \"strategy-001\",\n \"sorting\": \"PriceAsc\",\n \"resultCount\": 120,\n \"itemsPerPage\": 24,\n \"totalPages\": 5,\n \"currentPage\": 1,\n \"integrationType\": \"api\",\n \"createdAt\": \"2026-01-20T14:30:00Z\",\n \"products\": [\n {\n \"id\": \"product-001\",\n \"groupCode\": \"laptop-group-1\",\n \"price\": 999.99,\n \"convertedPrice\": 949.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"position\": 1,\n \"displayPosition\": 1,\n \"isMerchandisedItem\": false\n },\n {\n \"id\": \"product-002\",\n \"groupCode\": \"laptop-group-2\",\n \"price\": 1299.99,\n \"convertedPrice\": 1249.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"position\": 2,\n \"displayPosition\": 2,\n \"isMerchandisedItem\": false\n }\n ],\n \"eventType\": \"product-list-view\"\n}'\n\nRequired. Source URL of the referring page.
\n","type":"text/plain"},"key":"referrer","value":"String"},{"disabled":true,"description":{"content":"Campaign ID, provided in the Insider's InOne panel.
\n","type":"text/plain"},"key":"campId","value":"Integer"},{"disabled":true,"description":{"content":"Variation ID, provided in the Insider's InOne panel
\n","type":"text/plain"},"key":"variationId","value":"Integer"},{"disabled":true,"description":{"content":"Required. Source origin where the event triggered
\n","type":"text/plain"},"key":"source","value":"String"},{"disabled":true,"description":{"content":"Required
\n","type":"text/plain"},"key":"listValue","value":"String"},{"disabled":true,"description":{"content":"Required. Unique identifier of the user.
\n","type":"text/plain"},"key":"userId","value":"String"},{"disabled":true,"description":{"content":"Required. Platform used by the user.
\n","type":"text/plain"},"key":"platform","value":"String"},{"disabled":true,"description":{"content":"Required. Type of integration.
\n","type":"text/plain"},"key":"integrationType","value":"String"},{"disabled":true,"description":{"content":"Required. Unique trace identifier created for the current query.
\n","type":"text/plain"},"key":"traceId","value":"String"},{"disabled":true,"description":{"content":"Browser/app session identifier
\n","type":"text/plain"},"key":"sessionId","value":"String"},{"disabled":true,"description":{"content":"Optional strategy identifier
\n","type":"text/plain"},"key":"strategyId","value":"String"},{"disabled":true,"description":{"content":"Required. Sorting method used in the search request. It is the type of sorting object of the search response.
\n","type":"text/plain"},"key":"sorting","value":"String"},{"disabled":true,"description":{"content":"Required. Number of search results returned
\n","type":"text/plain"},"key":"resultCount","value":"Integer"},{"disabled":true,"description":{"content":"Number of items per page used in the search request
\n","type":"text/plain"},"key":"itemsPerPage","value":"Integer"},{"disabled":true,"description":{"content":"Total number of pages returned by the search
\n","type":"text/plain"},"key":"totalPages","value":"Integer"},{"disabled":true,"description":{"content":"Page number where the search results are displayed
\n","type":"text/plain"},"key":"currentPage","value":"Integer"},{"disabled":true,"description":{"content":"List of facets of the search. Required if any facet selected
\n","type":"text/plain"},"key":"facets","value":"List of facets"},{"disabled":true,"description":{"content":"Required. The product clicked by the user.
\n","type":"text/plain"},"key":"products","value":"List of product"},{"disabled":true,"description":{"content":"Required, equals=search. Type of event.
\n","type":"text/plain"},"key":"eventType","value":"String"},{"disabled":true,"description":{"content":"Required. Time when the event is created.
\n","type":"text/plain"},"key":"createdAt","value":"String"}],"variable":[]}},"response":[],"_postman_id":"68b3a9d0-5ab5-47a0-8d1f-656873672db6"},{"name":"Collect user's add to cart event","id":"19d03e81-d6a8-4863-b844-f556cb8bf9c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://eurekaevent.api.useinsider.com/api/v1/events","description":"The Event Collection API allows you to integrate user event collection functionality into Eureka. The API is designed to collect user events, such as search queries, clicks, add to carts, and purchases. You can use the collected data to improve Eureka’s performance and user experience.
\nThe Add to Cart event should be fired when a visitor adds an item to the cart from search results.
\nPOST https://eurekaevent.api.useinsider.com/api/v1/events
\nThe add to cart event supports the following properties:
\n\n\n
If your integration was implemented before the Advanced Analytics September 01, 2025, release, please note that new fields have been added to the expected product payload. Following this release, the event now retrieves currentPage and related details from product-level fields instead of top-level fields. In addition, the product object has been enriched with several new fields.
\nFor backward compatibility, you may continue sending these values at the event level. However, it is strongly recommended to update your implementation to the new product-level structure to ensure full alignment with the latest version and to benefit from more comprehensive analytics.
\nYou can review the full list of changes on the Common Properties page.
\nIn the example below, you see a sample request along with guidance on modifying the necessary fields. This will help you seamlessly integrate and make the most of the provided configuration.
\n\n\n
Before usage, modifying the values such as x-auth-token and x-partner-config-key is essential.
\ncurl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \\\n--header 'x-auth-token: YOUR_AUTH_TOKEN' \\\n--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"referrer\": \"https://example.com/search-results\",\n \"source\": \"product-detail\",\n \"userId\": \"user-12345\",\n \"platform\": \"ios\",\n \"campId\": 999999,\n \"variationId\": 999999,\n \"product\": {\n \"id\": \"product-001\",\n \"groupCode\": \"laptop-group-1\",\n \"query\": \"laptop\",\n \"price\": 1299.99,\n \"convertedPrice\": 1199.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"clickPosition\": 3,\n \"displayPosition\": 3,\n \"quantity\": 2,\n \"resultCount\": 25,\n \"itemsPerPage\": 10,\n \"totalPages\": 3,\n \"facets\": [\n {\n \"label\": \"Price\",\n \"field\": \"price_en\",\n \"values\": [\"500\", \"2000\"]\n },\n {\n \"label\": \"Brand\",\n \"field\": \"brand_en\",\n \"values\": [\"16GB\"]\n }\n ],\n \"sorting\": \"Relevancy\",\n \"currentPage\": 1,\n \"traceId\": \"search-session-abc123\",\n \"strategyId\":\"strategy-id-123\",\n \"sessionId\":\"session-id-123\",\n \"attributionWindow\": [\"7\", \"30\", \"90\"]\n },\n \"eventType\": \"add-to-cart\",\n \"integrationType\": \"api\",\n \"createdAt\": \"2025-11-25T10:40:00Z\"\n}'\n\nRequired. Source URL of the referring page.
\n","type":"text/plain"},"key":"referrer","value":"String"},{"disabled":true,"description":{"content":"Campaign ID, provided in the Insider's InOne panel.
\n","type":"text/plain"},"key":"campId","value":"Integer"},{"disabled":true,"description":{"content":"Variation ID, provided in the Insider's InOne panel
\n","type":"text/plain"},"key":"variationId","value":"Integer"},{"disabled":true,"description":{"content":"Source origin where the event triggered
\n","type":"text/plain"},"key":"source","value":"String"},{"disabled":true,"description":{"content":"Required. Type of integration.
\n","type":"text/plain"},"key":"integrationType","value":"String"},{"disabled":true,"description":{"content":"Required. Platform used by the user.
\n","type":"text/plain"},"key":"platform","value":"String"},{"disabled":true,"description":{"content":"Default. Unique identifier of the user. It is expected to provide for user-based calculations.
\n","type":"text/plain"},"key":"userId","value":"String"},{"disabled":true,"description":{"content":"Required. The product clicked by the user.
\n","type":"text/plain"},"key":"product","value":"Object"},{"disabled":true,"description":{"content":"Required, equals=search. Type of event.
\n","type":"text/plain"},"key":"eventType","value":"String"},{"disabled":true,"description":{"content":"Required. Time when the event is created.
\n","type":"text/plain"},"key":"createdAt","value":"String"}],"variable":[]}},"response":[],"_postman_id":"19d03e81-d6a8-4863-b844-f556cb8bf9c3"},{"name":"Collect user's purchase event","id":"4cb9b0a0-c227-4981-aabc-a67b6b16e98b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://eurekaevent.api.useinsider.com/api/v1/events","description":"The Event Collection API allows you to integrate user event collection functionality into Eureka. The API is designed to collect user events such as search queries, clicks, add to carts, and purchases. You can use the collected data to improve Eureka’s performance and user experience.
\n\n\n
POST https://eurekaevent.api.useinsider.com/api/v1/event
\nThe purchase event supports the following properties:
\n\n\n
If your integration was implemented before the Advanced Analytics September 01, 2025, release, please note that new fields have been added to the expected product payload. Following this release, the event now retrieves currentPage, source, and related details from product-level fields instead of top-level fields. In addition, the product object has been enriched with several new fields.
\nFor backward compatibility, you may continue sending these values at the event level. However, it is strongly recommended to update your implementation to the new product-level structure to ensure full alignment with the latest version and to benefit from more comprehensive analytics.
\nYou can review the full list of changes on the Common Properties page.
\nIn the example below, you see a sample request along with guidance on modifying the necessary fields. This will help you seamlessly integrate and make the most of the provided configuration.
\n\n\n
Before usage, modifying the values such as x-auth-token and x-partner-config-key is essential.
\ncurl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \\\n--header 'x-auth-token: YOUR_AUTH_TOKEN' \\\n--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"referrer\": \"https://example.com/cart\",\n \"userId\": \"user-12345\",\n \"platform\": \"android\",\n \"campId\": 100,\n \"variationId\": 200,\n \"orderId\": \"order-xyz789\",\n \"allPurchasedProducts\": [\n \"product-001\",\n \"product-002\",\n \"product-003\"\n ],\n \"products\": [\n {\n \"traceId\": \"search-session-abc123\",\n \"strategyId\":\"strategy-id-123\",\n \"sessionId\":\"session-id-123\",\n \"source\": \"category-listing\",\n \"id\": \"product-001\",\n \"groupCode\": \"laptop-group-1\",\n \"listValue\": \"pc~laptop\",\n \"resultCount\": 25,\n \"itemsPerPage\": 10,\n \"totalPages\": 3,\n \"currentPage\": 1,\n \"sorting\": \"PriceDesc\",\n \"facets\": [\n {\n \"label\": \"Fiyat\",\n \"field\": \"price\",\n \"values\": [\"500\", \"2000\"]\n }\n ],\n \"price\": 1299.99,\n \"convertedPrice\": 1199.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"clickPosition\": 1,\n \"displayPosition\": 1,\n \"quantity\": 2,\n \"attributionWindow\": [\"session\", \"1\", \"7\", \"30\", \"90\"]\n },\n {\n \"traceId\": \"search-session-def456\",\n \"strategyId\":\"strategy-id-123\",\n \"sessionId\":\"session-id-123\",\n \"source\": \"search-listing\",\n \"id\": \"product-002\",\n \"groupCode\": \"mouse-group-1\",\n \"query\": \"wireless mouse\",\n \"resultCount\": 15,\n \"itemsPerPage\": 10,\n \"totalPages\": 2,\n \"currentPage\": 1,\n \"sorting\": \"MostPopularFirst\",\n \"facets\": [\n {\n \"label\": \"Brand\",\n \"field\": \"brand_en\",\n \"values\": [\"Ltech\"]\n }\n ],\n \"price\": 49.99,\n \"convertedPrice\": 45.99,\n \"currency\": \"USD\",\n \"preferredCurrency\": \"EUR\",\n \"clickPosition\": 2,\n \"displayPosition\": 2,\n \"quantity\": 1,\n \"attributionWindow\": [\"session\", \"1\", \"7\", \"30\", \"90\"]\n }\n ],\n \"eventType\": \"purchase\",\n \"integrationType\": \"api\",\n \"createdAt\": \"2025-11-25T10:50:00Z\"\n}'\n\nRequired. Source URL of the referring page.
\n","type":"text/plain"},"key":"referrer","value":"String"},{"disabled":true,"description":{"content":"Campaign ID, provided in the Insider's InOne panel.
\n","type":"text/plain"},"key":"campId","value":"Integer"},{"disabled":true,"description":{"content":"Variation ID, provided in the Insider's InOne panel
\n","type":"text/plain"},"key":"variationId","value":"Integer"},{"disabled":true,"description":{"content":"Required. Platform used by the user.
\n","type":"text/plain"},"key":"platform","value":"String"},{"disabled":true,"description":{"content":"Required. Unique identifier of the user.
\n","type":"text/plain"},"key":"userId","value":"String"},{"disabled":true,"description":{"content":"Required. Type of integration.
\n","type":"text/plain"},"key":"integrationType","value":"String"},{"disabled":true,"description":{"content":"Required. Unique ID of the order with at least one product that received impression from the search event.
\n","type":"text/plain"},"key":"orderId","value":"String"},{"disabled":true,"description":{"content":"Required. List of all product IDs that were paid for.
\n","type":"text/plain"},"key":"allPurchasedProducts","value":"List of string"},{"disabled":true,"description":{"content":"Required. List of purchased products that received click from the search event.
\n","type":"text/plain"},"key":"products","value":"List of products"},{"disabled":true,"description":{"content":"Required, equals=search. Type of event.
\n","type":"text/plain"},"key":"eventType","value":"String"},{"disabled":true,"description":{"content":"Required. Time when the event is created.
\n","type":"text/plain"},"key":"createdAt","value":"String"}],"variable":[]}},"response":[],"_postman_id":"4cb9b0a0-c227-4981-aabc-a67b6b16e98b"}],"id":"c17ec092-0b9c-4733-bf88-4892e5c622ce","_postman_id":"c17ec092-0b9c-4733-bf88-4892e5c622ce","description":""},{"name":"Category Merchandising API","item":[{"name":"Manage product listing pages","id":"7043d4fd-c909-4fab-a4a7-ddad6098fb0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ineureka.api.useinsider.com/api/web/collections/{type}?cf={COLLECTION_FILTER}&p={PARTNER_ID}&l={LOCALE}&c={CURRENCY}","description":"Eureka’s Category Merchandising API allows you to effectively curate and manage your product listing pages. Tailored for various list pages like categories, sales, new arrivals, and brands, enables you to pin, boost, bury, or hide specific products as needed. You can set the rules using a visual merchandising editor to customize content for specific categories. Once you apply the rules, you can build the listing pages by making an API call based on the type of listing page and its filter.
\nThe initial step involves sending your data in the correct format to Insider, typically handled through system rules defined during website mapping.
\nCategory Merchandising API responses are in JSON format, containing product matching criteria, configured merchandising content, and available facet options for further refinement.
\nFor product details, Insider One product catalog integration methods (XML, Catalog API, and Clickstream) should be created.
\nData collection should be activated by the Insider One team.
\nEureka should be activated by the Insider One team.
\nIf you want to use dynamic filters (facets) and sortings in the category pages, you need to set these configurations via Eureka Settings in Insider One's InOne panel.
\nNote: For requests where the total URL length exceeds 2,048 characters, a POST request must be sent to the base URL: https://ineureka.api.useinsider.com/api/web/collections. While the HTTP protocol itself does not define an explicit maximum URL length, practical limitations exist across browsers, web servers, proxies, and load balancers.
To prevent compatibility issues and request failures, we enforce the length threshold as a precautionary measure. Although GET requests may yield faster responses in some cases, it is important to transition to POST when the payload size approaches or exceeds approximately 2,000 characters.
This ensures compliance with common platform constraints and avoids potential truncation, rejection, or undefined behavior resulting from excessively long URLs.
The only difference between GET and POST requests is that the values sent as URL parameters in GET requests must be sent as JSON body in POST requests. For example:
\n{\n \"cf\": \"COLLECTION_FILTER\",\n \"p\": \"PARTNER_ID\",\n \"l\": \"LOCALE\",\n \"c\": \"CURRENCY\",\n \"sid\": \"STRATEGY_ID\"\n}\n\nWhen the request is sent, an authentication exception is thrown for security reasons. Therefore, when sending the request, set the X-AUTH-TOKEN header to the token shared with you and send the request.
\nWhen retrieving products from the product catalog, three different collection types help organize and filter results based on specific criteria. These collection types are:
\nThe Category Collection type allows the retrieval of all products in the catalog that belong to a specific category, helping narrow down their results based on product type. For example, to get all shoes, you can retrieve products under the \"Footwear\" category.
\nThe Brand Collection type allows you to retrieve all products from a specific brand in the catalog, helping users access products from their preferred brands easily. For example, if you want to get all Nike products, you can use this option to retrieve only items from the \"Nike\" brand.
\nThe All Products Collection type allows the retrieval of all products in the catalog without any restrictions, providing access to the entire product catalog. For example, if you want to see all products, you can use this option to retrieve all products in the catalog.
\nUsing these collection types, you can retrieve products efficiently based on your specific needs.
\nThe st parameter in the request can only have one value from the predefined sorting types. Using these types, the sorting algorithm for the listed products is selected. Depending on your data, the sorting types can be active or inactive. You can view these settings on the InOne panel.
\nYou can filter listed products using field names in the filter settings defined in faceting in Insider's InOne panel.
\nSample filter request:
\n&a=category~Skin~Body Lotions&a=price~5~10\n\nAs a result of this filter request, you can see the matched facets in the related property sections of items as below:
\n{\n \"itemProperties\": {\n \"item_card\": {\n \"price\": {\n \"EUR\": 7.75,\n ...\n },\n \"category\": [\n \"Skin\",\n \"Body Lotions\",\n ...\n ],\n \"in_stock\": 1,\n ...\n },\n ...\n },\n ...\n}\n\nThe field values you can use for facet filtering are provided under data.aggregations in the result.
\n[\n {\n \"name\": \"price\",\n \"label\": \"Price\",\n \"style\": \"Slider\",\n \"items\": [\n {\n \"name\": \"0~5\",\n \"min\": 0.0,\n \"max\": 5.0\n },\n {\n \"name\": \"5~10\",\n \"min\": 5.0,\n \"max\": 10.0\n },\n ...\n ],\n \"sequence\": 1,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"category\",\n \"label\": \"Category\",\n \"style\": \"List\",\n \"items\": [\n {\n \"name\": \"Skin\",\n \"selected\": true,\n \"documentCount\": 66\n },\n {\n \"name\": \"Body Lotion\",\n \"selected\": true,\n \"documentCount\": 61\n },\n ...\n ],\n \"sequence\": 2,\n \"itemOrderType\": \"CountDesc\"\n },\n {\n \"name\": \"in_stock\",\n \"label\": \"In Stock\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"1\",\n \"selected\": false,\n \"documentCount\": 12\n },\n ...\n ],\n \"sequence\": 3,\n \"itemOrderType\": \"CountDesc\"\n },\n ...\n]\n\nThis table details the facet filter styles and their corresponding data types. Based on the specific filter style you want to implement, choose the appropriate data type.
\nFor the filters with numeric data types, such as Slider style, there should be only two values: min and max.
\n{field}~{minValue}~{maxValue}\n\n&a=brand~Neki\n\n&a=category~Birds~Cats~Dogs\n\n&a=price~50~100\n\n&a=brand~Neki&a=price~50~100\n\n{ \n \"status\": \"Success\",\n \"data\": {\n \"items\": [...],\n \"aggregations\": [...],\n \"navigation\": {...},\n \"noResultPageText\": \"...\",\n \"sortings\": [...]\n },\n \"redirection\": null,\n \"partnerResources\": {...},\n \"error\": null,\n \"validations\": null\n}\n\n{ \n \"status\": \"Error\",\n \"data\": null,\n \"redirection\": null,\n \"partnerResources\": null,\n \"error\": {\n \"code\": \"500 INTERNAL_SERVER_ERROR\",\n \"message\": \"...\" \n },\n \"validations\": null\n}\n\n{ \n \"status\": \"BusinessException\",\n \"data\": null,\n \"redirection\": null,\n \"partnerResources\": null,\n \"error\": {\n \"code\": \"...\",\n \"message\": \"...\" \n },\n \"validations\": null\n}\n\n{ \n \"status\": \"Invalid\", \n \"data\": null, \n \"redirection\": null, \n \"partnerResources\": null,\n \"error\": null,\n \"validations\": [\n {\n \"type\": \"...\",\n \"message\": \"...\"\n }\n ]\n}\n\nThe Category Collection type allows the retrieval of all products belonging to a specific category in the product catalog, helping to narrow down results based on product type. For example, if you want to get all shoes, you can retrieve products under the \"Footwear\" category.
\nSome catalogs use a non-hierarchical or flat category structure where categories are not nested (e.g., Shoes, Footwear instead of Women > Shoes > Sneakers). In this case, you can retrieve products within singular categories like Shoes.
\nWhen multiple singular categories are used in a flat category search, only products belonging to both categories are returned. These categories are connected using an \"AND\" condition, meaning that a product must be classified under both to be included. For example, searching for Shoes and Footwear will return only products categorized as both Shoes and Footwear.
\nThe cf parameter should be formatted the same way as in hierarchical structures, such as shoes or shoes~footwear
\nMerchandising rules cannot be applied to multiple flat category retrievals.
\nSome catalogs use a hierarchical category structure, where categories follow a parent-child relationship (e.g., Women > Shoes > Sneakers). In this case, searches should use the full structure to ensure accurate results. For example, to retrieve products under Women > Shoes, use Women~Shoes.
\nYou can select Flat or Hierarchical structure from Catalog Settings > Category Type page in the InOne panel.
\nTo use the Category Collection type, the category attribute in the product catalog must be properly populated to ensure product retrieval.
\nThe type path variable value must exactly match the example values provided in the request parameter table. The cf parameter value must exactly match the values defined in the product catalog.
\nThe sid (Strategy ID) parameter enables strategy-based merchandising. When a valid strategy ID is provided, the API applies the merchandising rules associated with that strategy to the search results. This includes product-level actions (boost, high-boost, bury, high-bury, pin, hide) and attribute-level actions (boost attribute, bury attribute, hide by attribute).
**- If sid is omitted, no strategy-based merchandising rules are applied to the search results.
**- Additionally, if Eureka Strategies are enabled for your account, refer to the image below showing where to locate the sid:
![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/image-1775147786886.png\")
","urlObject":{"protocol":"https","path":["api","web","collections"],"host":["ineureka","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcb1420f-b28e-4b9f-bbdb-7f6a0025eb4a"},{"name":"Brand Collection","id":"959cfe48-2e5b-405a-bb4e-7a043ae31053","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ineureka.api.useinsider.com/api/web/collections","description":"The Brand Collection enables searching for products under a specific brand name.
\nThe Brand Collection accepts only singular values for the cf parameter, meaning searches can be performed using only one brand value at a time.
\nTo use the Brand Collection type, ensure that the brand attribute in the product catalog is properly populated for accurate product retrieval.
\nMerchandising rules cannot be applied to the Brand Collection.
\nThe type path variable value must exactly match the example values provided in the request parameter table.
\n","urlObject":{"protocol":"https","path":["api","web","collections"],"host":["ineureka","api","useinsider","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"959cfe48-2e5b-405a-bb4e-7a043ae31053"},{"name":"All Products Collection","id":"1e86c1b7-3754-4206-9258-b5762bd65923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"The All Product Collection type provides a comprehensive search across all products in the catalog. It’s ideal for retrieving all products.
\nUnlike Category and Brand collections, the All Product collection does not require or use the cf parameter.
If the cf parameter is included in a request, the API will return a validation error, preventing the request from being processed.
Merchandising rules cannot be applied to the All Product Collection.
\nThe type path variable value must exactly match the example values provided in the request parameter table.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"1e86c1b7-3754-4206-9258-b5762bd65923"}],"id":"66bdf65a-4b8a-4bdd-8c3c-5a8ea584ee22","_postman_id":"66bdf65a-4b8a-4bdd-8c3c-5a8ea584ee22","description":""},{"name":"Get search results","id":"cbbec6de-4785-436d-89f8-b4c14074da58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ineureka.api.useinsider.com/api/web/search","description":"Eureka’s API (Search API) lets you quickly and smoothly implement our search engine within your website(s) or mobile application(s). Insider's powerful search engine powers millions of queries every month and can deliver relevant results in under 150-400 ms, regardless of the location.
\nThe first step is to send your data in the correct format to Insider. Eureka will return the results in JSON. The response will include products matching the search criteria, available facet options to refine the results further, and configured merchandising content.
\nThe Insider team should activate Eureka.
\nProduct Catalog integration methods (XML, Catalog API, and Clickstream) should be created for product details.
\nEureka settings, such as facets, sorting options, synonyms, URL redirections, etc., should be defined on the Insider's InOne panel.
\nFor requests with a total length, which is the length of the entire URL, exceeding 2048 characters, a POST request must be sent to the base URL (https://ineureka.api.useinsider.com/api/web/search).
\nAlthough the HTTP protocol specification does not specify a maximum length, web browsers and server software impose practical limits. We limit length as a precaution to meet these limits and avoid problems. GET requests may return faster responses, but we highly suggest you consider this when the payload length increases to 2000+ characters.
\nThe only difference between GET and POST requests is that the values sent as URL parameters in GET requests must be sent as JSON body in POST requests, as you can see below:
\n{\n \"q\": \"SEARCH_QUERY\",\n \"p\": \"PARTNER_ID\",\n \"l\": \"LOCALE\",\n \"c\": \"CURRENCY\"\n}\n\nBear in mind that when the request is sent, an authentication exception is thrown for security reasons. In order to avoid this, you need to set the X-AUTH-TOKEN field in the header with the token while sending the request.
\nThe query q parameter should contain at least 2 and 280 characters. Otherwise, a validation exception will be thrown.
\nThe qs parameter should not be included in the initial request made by the end user for a query. You can find it in the response body after the first result returns. However, it needs to be added in subsequent requests when applying the facet filter for the same query. Otherwise, the request is accepted as a new query, and the search results may differ.
\nThe sid (Strategy ID) parameter enables strategy-based merchandising. When a valid strategy ID is provided, the API applies the merchandising rules associated with that strategy to the search results. This includes product-level actions (boost, high-boost, bury, high-bury, pin, hide) and attribute-level actions (boost attribute, bury attribute, hide by attribute).
**- If sid is omitted, no strategy-based merchandising rules are applied to the search results.
**- Additionally, if Eureka Strategies are enabled for your account, refer to the image below showing where to locate the sid:
![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/image-1775146935702.png\")
\n\nThe st parameter in the request can only have one value from the predefined sorting types. Using these types, the sorting algorithm for the searched products is selected. Depending on your data, the sorting types can be active or inactive, you can view these settings on the InOne panel.
\nSearch results can be filtered using fields in filter settings defined in faceting on the Insider's InOne panel.
\n&a=category~Skin~Body Lotions&a=price~5~10\n\nIn the result of this filter request, you can see the matched facets in the related result section as below:
\n{\n \"itemProperties\": {\n \"item_card\": {\n \"price\": {\n \"EUR\": 7.75,\n ...\n },\n \"category\": [\n \"Skin\",\n \"Body Lotions\",\n ...\n ],\n \"in_stock\": 1,\n ...\n },\n ...\n },\n ...\n}\n\nThe field values that you can use for facet filtering is provided under data.aggregations in the result.
\n[\n {\n \"name\": \"price\",\n \"label\": \"Price\",\n \"style\": \"Slider\",\n \"items\": [\n {\n \"name\": \"0~5\",\n \"min\": 0.0,\n \"max\": 5.0\n },\n {\n \"name\": \"5~10\",\n \"min\": 5.0,\n \"max\": 10.0\n },\n ...\n ],\n \"sequence\": 1,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"category\",\n \"label\": \"Category\",\n \"style\": \"List\",\n \"items\": [\n {\n \"name\": \"Skin\",\n \"selected\": true,\n \"documentCount\": 66\n },\n {\n \"name\": \"Body Lotion\",\n \"selected\": true,\n \"documentCount\": 61\n },\n ...\n ],\n \"sequence\": 2,\n \"itemOrderType\": \"CountDesc\"\n },\n {\n \"name\": \"in_stock\",\n \"label\": \"In Stock\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"1\",\n \"selected\": false,\n \"documentCount\": 12\n },\n ...\n ],\n \"sequence\": 3,\n \"itemOrderType\": \"CountDesc\"\n },\n ...\n]\n\n\"a\" parameter should be passed to the request as a query string when the request method is GET, or it should be passed as a list of strings when the request method is POST. The \"a\" can take multiple fields and each must be stated separately. Also, the field can take multiple values separated by a tilda (~). Field values should be different and if there is more than one value, they should be written by separating them according to the filter pattern.
\n?a={field}~{value}&a={field}~{value}\n\n{\"a\": [\"{field}~{value}\", \"{field}~{value}\"]}\n\nFor the filters with numeric data type such as Slider style, there should be only two values min and max.
\n{field}~{minValue}~{maxValue}\n\n&a=brand~Mybrand\n\n&a=category~Birds~Cats~Dogs\n\n&a=price~50~100\n\n&a=brand~Mybrand&a=price~50~100\n\n{ \n\"status\": \"Success\",\n \"data\": {\n\"items\": [ … ],\n\"aggregations\": [ … ],\n\"navigation\": { … },\n\"noResultPageText\": “No Result”,\n\"sortings\": [ … ]\n},\n\"redirection\": null,\n\"error\": null,\n\"validations\": null \n}\n\n{\n \"status\": \"SuccessFallback\",\n \"data\": {\n \"items\": [...],\n \"brands\": [...],\n \"categories\": [...],\n \"noResultPageText\": \"...\",\n \"defaultSortingType\": null\n },\n \"redirection\": null,\n \"partnerResources\": {...},\n \"error\": null,\n \"validations\": null,\n \"appliedSearchStrategy\": \"...\"\n}\n\n{\n \"status\": \"Invalid\",\n \"data\": null,\n \"redirection\": null,\n \"partnerResources\": null,\n \"error\": null,\n \"validations\": [\n {\n \"type\": \"...\",\n \"message\": \"...\"\n }\n ],\n \"appliedSearchStrategy\": null\n}\n\n{\n \"status\": \"Error\",\n \"data\": null,\n \"redirection\": null,\n \"partnerResources\": null,\n \"error\": {\n \"code\": \"500 INTERNAL_SERVER_ERROR\",\n \"message\": \"...\"\n },\n \"validations\": null,\n \"appliedSearchStrategy\": null\n}\n\n{\n \"status\": \"BusinessException\",\n \"data\": null,\n \"redirection\": null,\n \"partnerResources\": null,\n \"error\": {\n \"code\": \"...\",\n \"message\": \"...\"\n },\n \"validations\": null,\n \"appliedSearchStrategy\": null\n}\n\nRequired. Query String that will be searched.
\n","type":"text/plain"},"key":"q","value":"{SEARCH_QUERY}"},{"disabled":true,"description":{"content":"Required. This is your partner name. Navigate to InOne > InOne Settings > Account Preferences to copy your partner id.
\n","type":"text/plain"},"key":"p","value":""},{"disabled":true,"description":{"content":"Required. Locale is required to get partner products in the current language of the website. E.g. en_US, en_GB
\n","type":"text/plain"},"key":"l","value":"en_US"},{"disabled":true,"description":{"content":"The searched products will be displayed in the given currency (The current currency that has been selected by the end user on your website). E.g. USD, AUD
\n","type":"text/plain"},"key":"c","value":"USD"},{"disabled":true,"description":{"content":"Number of products will return in the response. For example, if phone is searched with ps=5, then the API will bring the most relevant 5 phones to the current page. The default value is ps=6.
\n","type":"text/plain"},"key":"ps","value":"6"},{"disabled":true,"description":{"content":"The searched products starting index from the given page number will be displayed. The default value is pf=0.
\n","type":"text/plain"},"key":"pf","value":"0"},{"disabled":true,"description":{"content":"Filter the products with the following pattern: a={field}~{value}
\n","type":"text/plain"},"key":"a","value":""},{"disabled":true,"description":{"content":"Sorting type of the searched products. It only takes one of the predefined sorting types. The default value is st=Relevancy.
\n","type":"text/plain"},"key":"st","value":""},{"disabled":true,"description":{"content":"User ID. It can be found on localstorage by the key name spUID. spUID is a stringified object and it contains data and expire properties. User Id should be sent if the personalized search is active.
\n","type":"text/plain"},"key":"u","value":"a1b2c3d4"},{"disabled":true,"description":{"content":"The searched products will be displayed as only item ids.
\n","type":"text/plain"},"key":"oi","value":""},{"disabled":true,"description":{"content":"Applied strategies of the search query. It only takes an encoded string that is auto-generated by the first query in the response. Its data type is string.
\n","type":"text/plain"},"key":"qs","value":""}],"variable":[]}},"response":[{"id":"a9ab633e-ad71-445e-a82c-d1a7361a093c","name":"Get 1 relevant product in search result","originalRequest":{"method":"GET","header":[{"key":"authority","value":"eureka.api.useinsider.com"},{"key":"accept","value":"*/*"},{"key":"accept-language","value":"en-GB"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://www.example.useinsider.com"},{"key":"referer","value":"https://www.example.useinsider.com"},{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"113\", \"Chromium\";v=\"113\", \"Not-A.Brand\";v=\"24\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"sec-fetch-dest","value":"empty"},{"key":"sec-fetch-mode","value":"cors"},{"key":"sec-fetch-site","value":"cross-site"},{"key":"user-agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36"},{"key":"x-auth-token","value":"EurekaSearchAPI"}],"url":{"raw":"https://eureka.api.useinsider.com/api/web/search?q=dog%20food&p=PartnerID&l=en_GB&c=GBP&u=UserID&ps=1&pf=1&a=filter_type_of_nutrition~Dry%20Food~Treats&st=Relevancy","protocol":"https","host":["eureka","api","useinsider","com"],"path":["api","web","search"],"query":[{"key":"q","value":"dog%20food"},{"key":"p","value":"PartnerID"},{"key":"l","value":"en_GB"},{"key":"c","value":"GBP"},{"key":"u","value":"UserID"},{"key":"ps","value":"1"},{"key":"pf","value":"1"},{"key":"a","value":"filter_type_of_nutrition~Dry%20Food~Treats"},{"key":"st","value":"Relevancy"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 May 2023 10:06:57 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Set-Cookie","value":"__cf_bm=RMIFSdiH6m58W0f9g1S7Y1J3nge.CSTOJeo32hSPSC8-1685354817-0-AVAiaLMWERrg70y+Kf3YxLC+i2wMNKJOJxzWnbl+StUzVkHAcGyRcr9sVIzoRFPsxCsLFbYEL61ibdhjvPW1M0Y=; path=/; expires=Mon, 29-May-23 10:36:57 GMT; domain=.useinsider.com; HttpOnly; Secure; SameSite=None","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7ceded78298218cf-FRA","enabled":true},{"key":"Content-Encoding","value":"br","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"data\": {\n \"items\": [\n {\n \"itemId\": \"DF123456\",\n \"itemProperties\": {\n \"item_card\": {\n \"original_price\": {\n \"GBP\": 31.75\n },\n \"item_id\": \"DF123456\",\n \"image_url\": \"https://example.useinsider.com/product-images/catalog/df123456.jpeg\",\n \"price\": {\n \"GBP\": 31.75\n },\n \"product_attributes\": {\n \"filter_type_of_supplies\": \"\",\n \"filter_breed\": \"Poodle\",\n \"type_of_nutrition\": \"Dry Food\",\n \"filter_product_range\": \"Healthy Nutrition\",\n \"filter_life_stage\": \"Puppy\",\n \"flavour\": \"Poultry flavour\",\n \"type_of_animal\": \"Dogs\",\n \"filter_type_of_animal\": \"Dogs\",\n \"filter_type_of_nutrition\": \"Dry Food\",\n \"product_range\": \"Healthy Nutrition\",\n \"filter_flavour\": \"Poultry flavour\",\n \"breed\": \"Poodle\",\n \"product_series\": \"\",\n \"life_stage\": \"Puppy\",\n \"price_per_unit\": \"10.58 / kg\",\n },\n \"name\": \"Dog Food Poodle Puppy - 3 kg\",\n \"discount\": {\n \"GBP\": 0\n },\n \"id\": \"DF123456:en_GB\",\n \"in_stock\": 1,\n \"locale\": \"en_GB\",\n \"category\": [\n \"Dogs\",\n \"food\",\n \"dry-food\"\n ],\n \"url\": \"https://www.example.useinsider.com/poodle-puppy-dog-food?sku=DF123456\"\n }\n },\n \"itemVariants\": [\n {\n \"original_price\": {\n \"GBP\": 31.75\n },\n \"item_id\": \"DF123456\",\n \"image_url\": \"https://example.useinsider.com/product-images/catalog/df123456.jpeg\",\n \"price\": {\n \"GBP\": 31.75\n },\n \"product_attributes\": {\n \"filter_type_of_supplies\": \"\",\n \"filter_breed\": \"Poodle\",\n \"type_of_nutrition\": \"Dry Food\",\n \"filter_product_range\": \"Healthy Nutrition\",\n \"filter_life_stage\": \"Puppy\",\n \"flavour\": \"Poultry flavour\",\n \"type_of_animal\": \"Dogs\",\n \"filter_type_of_animal\": \"Dogs\",\n \"filter_type_of_nutrition\": \"Dry Food\",\n \"product_range\": \"Healthy Nutrition\",\n \"filter_flavour\": \"Poultry flavour\",\n \"breed\": \"Poodle\",\n \"product_series\": \"\",\n \"life_stage\": \"Puppy\",\n \"price_per_unit\": \"10.58 / kg\",\n },\n \"name\": \"Dog Food Poodle Puppy - 3 kg\",\n \"discount\": {\n \"GBP\": 0\n },\n \"id\": \"DF123456:en_GB\",\n \"in_stock\": 1,\n \"locale\": \"en_GB\",\n \"category\": [\n \"Dogs\",\n \"food\",\n \"dry-food\"\n ],\n \"url\": \"https://www.example.useinsider.com/poodle-puppy-dog-food?sku=DF123456\"\n }\n ]\n }\n ],\n \"aggregations\": [\n {\n \"name\": \"filter_dog_breed\",\n \"label\": \"Filter dog breed\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Poodle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Labrador Retriever\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Beagle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"German Shepherd\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Basset Hound\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Bulldog\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"French Bulldog\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Alaskan Malamute\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 1,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_type_of_nutrition\",\n \"label\": \"Filter type of nutrition\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Diet Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 78\n },\n {\n \"name\": \"Dry Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": true,\n \"documentCount\": 147\n },\n {\n \"name\": \"Puppy Milk\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Adult Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Treats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": true,\n \"documentCount\": 2\n },\n {\n \"name\": \"Wet Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 49\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 3,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_product_series\",\n \"label\": \"Filter product series\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Ageing\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Veterinary Diets\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Food 1\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Food 2\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Food 3\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Food 4\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Food 5\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Food 6\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Mother & Puppy\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Neutered Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Neutered Junior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Food 7\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Food 8\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Healthy Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Nutrition Maxi\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 9\n },\n {\n \"name\": \"Nutrition Medium\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 7\n },\n {\n \"name\": \"Nutrition Mini\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 11\n },\n {\n \"name\": \"Daily Life\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Starter\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Sterilised\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 8\n },\n {\n \"name\": \"X-Small\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 5,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_product_range\",\n \"label\": \"Filter product range\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Healthy Nutrition New\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 57\n },\n {\n \"name\": \"Dog Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 29\n },\n {\n \"name\": \"Daily Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 21\n },\n {\n \"name\": \"Health Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 23\n },\n {\n \"name\": \"Vet Care Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 14\n },\n {\n \"name\": \"Veterinary Diet\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 6,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_flavour\",\n \"label\": \"Filter flavour\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Beef\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Fish flavour\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Pork\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Poultry flavour\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 132\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 7,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_disease\",\n \"label\": \"Filter disease\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Ageing & Dementia\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 12\n },\n {\n \"name\": \"Allergies\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n },\n {\n \"name\": \"Breeding & Puppies\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Breeding & Adult Dogs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Digestive System\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 11\n },\n {\n \"name\": \"Fear\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Hairballs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Hormones & Fertility\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Joints & Muscles\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Kidneys & Urinary Tracts\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n },\n {\n \"name\": \"Obesity\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 16\n },\n {\n \"name\": \"Teeth\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 8,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_breed\",\n \"label\": \"Filter breed\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Beagle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Bichon Frise\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Boxer\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Bulldog\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Cavalier King Charles Spaniel\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Chihuahua\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Dachshund\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Dalmatian\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"French Bulldog\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"German Shepherd\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 7\n },\n {\n \"name\": \"Golden Retriever\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Jack Russel Terier\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Labradoodle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Labrador Retriever\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Maltese\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Miniature Schnauzer\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Poodle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Pug\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Rottweiler\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Shih Tzu\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"West Highland White Terrier\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Yorkshire Terrier\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 10,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filtery_type_of_snack\",\n \"label\": \"Filtery type of snack\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Training Treats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 12,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_life_stage\",\n \"label\": \"Filter life stage\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 94\n },\n {\n \"name\": \"Junior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Kitten\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n },\n {\n \"name\": \"Puppy\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 30\n },\n {\n \"name\": \"Senior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 15\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 14,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"filter_type_of_animal\",\n \"label\": \"Filter type of animal\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Cats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 40\n },\n {\n \"name\": \"Dogs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 109\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 18,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"type_of_animal\",\n \"label\": \"Type of animal\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Cats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 40\n },\n {\n \"name\": \"Dogs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 109\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 19,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"brand\",\n \"label\": \"Brand\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Dog Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 149\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 20,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"category\",\n \"label\": \"Category\",\n \"style\": \"List\",\n \"items\": [\n {\n \"name\": \"food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 149\n },\n {\n \"name\": \"dry-food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 147\n },\n {\n \"name\": \"Dogs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 109\n },\n {\n \"name\": \"Cats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 40\n },\n {\n \"name\": \"training-treats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"treats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 21,\n \"itemOrderType\": \"CountDesc\"\n },\n {\n \"name\": \"type_of_nutrition\",\n \"label\": \"Type of nutrition\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Dry Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 144\n },\n {\n \"name\": \"Dry Food, Diet Food\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Treats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 22,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"type_of_snack\",\n \"label\": \"Type of snack\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Training Treats\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 23,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"type_of_daily_requirement\",\n \"label\": \"Type of daily requirement\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Fitness\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 27,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"disease\",\n \"label\": \"Disease\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Ageing & Dementia\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 8\n },\n {\n \"name\": \"Ageing & Dementia, Allergies, Itching & Skin, Digestive System\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Ageing & Dementia, Digestive System\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Ageing & Dementia, Hormones & Fertility\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Ageing & Dementia, Joints & Muscles\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Allergies, Itching & Skin\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Allergies, Itching & Skin, Digestive System\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Allergies, Itching & Skin, Skin & Coat Care\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Breeding & Kittens\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Breeding & Puppies\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Digestive System\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n },\n {\n \"name\": \"Digestive System, Hairballs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n },\n {\n \"name\": \"Fear, Behaviour & Stress\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Hairballs\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Hormones & Fertility\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Hormones & Fertility, Stamina\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Joints & Muscles\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Joints & Muscles, Digestive System\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Kidneys & Urinary Tracts\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Kidneys & Urinary Tracts, Bladder, Kidneys, Liver & Heart\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Obesity\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n },\n {\n \"name\": \"Obesity, Hormones & Fertility\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 9\n },\n {\n \"name\": \"Obesity, Hormones & Fertility, Stamina\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Teeth\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 31,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"life_stage\",\n \"label\": \"Life stage\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 80\n },\n {\n \"name\": \"Adult, Senior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 14\n },\n {\n \"name\": \"Junior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Junior, Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Junior, Adult, Senior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Kitten\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n },\n {\n \"name\": \"Kitten, Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Puppy\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 9\n },\n {\n \"name\": \"Puppy, Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Puppy, Junior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 17\n },\n {\n \"name\": \"Puppy, Junior, Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Senior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 14\n },\n {\n \"name\": \"Senior, Junior, Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 35,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"breed\",\n \"label\": \"Breed\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Beagle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Bichon Frise\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Boxer\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Bulldog\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Cavalier King Charles Spaniel\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Chihuahua\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Dachshund\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Dalmatian\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"French Bulldog\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"German Shepherd\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 7\n },\n {\n \"name\": \"Golden Retriever\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Jack Russel Terier\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Labradoodle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Labrador Retriever\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Maltese\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Miniature Schnauzer\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Poodle\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Pug\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Rottweiler\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Shih Tzu\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"West Highland White Terrier\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Yorkshire Terrier\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 36,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"cat_breed\",\n \"label\": \"Cat breed\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Bengal\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"British Shorthair\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Maine Coon\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Norwegian Forest Cat\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Persian\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Ragdoll\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Siamese Cat\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Sphynx\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 37,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"flavour\",\n \"label\": \"Flavour\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Beef, Pork, Poultry flavour\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Fish flavour\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Pork\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Pork, Poultry flavour\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Poultry flavour\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 132\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 38,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"size\",\n \"label\": \"Size\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"L\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n },\n {\n \"name\": \"Small\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 39,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"product_series\",\n \"label\": \"Product series\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Ageing\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Calibra Veterinary Diets Renal\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Cocker\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Dermacomfort\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Dermacomfort, Size Health Nutrition Maxi\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Dermacomfort, Size Health Nutrition Medium\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Exigent\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Great Dane\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Indoor\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Light Weight Care\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Light Weight Care, Size Health Nutrition Medium\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Mother & Babycat\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Neutered Adult\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Neutered Junior\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Renal, Calibra Veterinary Diets Renal\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Satiety\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Size Health Nutrition Giant\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 4\n },\n {\n \"name\": \"Size Health Nutrition Maxi\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n },\n {\n \"name\": \"Size Health Nutrition Maxi, Ageing\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Size Health Nutrition Maxi, Calm Diet\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Size Health Nutrition Maxi, Light Weight Care\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Size Health Nutrition Medium\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n },\n {\n \"name\": \"Size Health Nutrition Medium, Ageing\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Size Health Nutrition Medium, Calm Diet\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Size Health Nutrition Mini\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 9\n },\n {\n \"name\": \"Size Health Nutrition Mini, Ageing\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Size Health Nutrition Mini, Calm Diet\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Sporting Life\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 2\n },\n {\n \"name\": \"Starter\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"Sterilised\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 6\n },\n {\n \"name\": \"Sterilised, Size Health Nutrition Maxi\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Sterilised, Size Health Nutrition Medium\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"X-Small\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 3\n },\n {\n \"name\": \"X-Small, Ageing\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 41,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"product_range\",\n \"label\": \"Product range\",\n \"style\": \"Checkboxes\",\n \"items\": [\n {\n \"name\": \"Breed Health Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 57\n },\n {\n \"name\": \"Canine Care Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 29\n },\n {\n \"name\": \"Lifestyle Health Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 21\n },\n {\n \"name\": \"Size Health Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 22\n },\n {\n \"name\": \"Size Health Nutrition, Lifestyle Health Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 1\n },\n {\n \"name\": \"Vet Care Nutrition\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 14\n },\n {\n \"name\": \"Veterinary Diet\",\n \"label\": null,\n \"min\": null,\n \"max\": null,\n \"selected\": false,\n \"documentCount\": 5\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 42,\n \"itemOrderType\": \"KeyAsc\"\n },\n {\n \"name\": \"price\",\n \"label\": \"Price\",\n \"style\": \"Slider\",\n \"items\": [\n {\n \"name\": \"0-10\",\n \"label\": null,\n \"min\": 0,\n \"max\": 10,\n \"selected\": null,\n \"documentCount\": null\n },\n {\n \"name\": \"10-20\",\n \"label\": null,\n \"min\": 10,\n \"max\": 20,\n \"selected\": null,\n \"documentCount\": null\n },\n {\n \"name\": \"20-30\",\n \"label\": null,\n \"min\": 20,\n \"max\": 30,\n \"selected\": null,\n \"documentCount\": null\n },\n {\n \"name\": \"30-70\",\n \"label\": null,\n \"min\": 30,\n \"max\": 70,\n \"selected\": null,\n \"documentCount\": null\n },\n {\n \"name\": \"70-110\",\n \"label\": null,\n \"min\": 70,\n \"max\": 110,\n \"selected\": null,\n \"documentCount\": null\n }\n ],\n \"prefixUnit\": null,\n \"suffixUnit\": null,\n \"sequence\": 43,\n \"itemOrderType\": \"KeyAsc\"\n }\n ],\n \"navigation\": {\n \"totalPages\": 278,\n \"currentPage\": 2,\n \"totalItems\": 278,\n \"itemPerPage\": 1\n },\n \"noResultPageText\": null,\n \"sortings\": [\n {\n \"type\": \"Relevancy\",\n \"label\": \"Most Relevant\",\n \"selected\": false\n },\n {\n \"type\": \"PriceAsc\",\n \"label\": \"Price: Low to High\",\n \"selected\": false\n },\n {\n \"type\": \"PriceDesc\",\n \"label\": \"Price: High to Low\",\n \"selected\": false\n }\n ]\n },\n \"redirection\": null,\n \"partnerResources\": {\n \"@SliderMax\": \"Max\",\n \"@FacetsSearchPlaceholder\": \"Search…\",\n \"@NoResultHeader\": \"No Search Results\",\n \"@ClearAll\": \"Clear All\",\n \"@RecommendationHeader\": \"Recommended For You\",\n \"@AddToCart\": \"Add To Cart\",\n \"@ItemsPerPage\": \"Items Per Page\",\n \"@SearchPlaceholder\": \"Search anything\",\n \"@Apply\": \"Apply\",\n \"@AppliedFilters\": \"Applied Filters\",\n \"@ShowMore\": \"Show More\",\n \"@FilterHeader\": \"Filters\",\n \"@SliderMin\": \"Min\",\n \"@SuccessHeader\": \"Results for\",\n \"@Sort\": \"Sort By\",\n \"@BrandFacetsHeader\": \"Brands\",\n \"@CategoryFacetsHeader\": \"Categories\",\n \"@Discount\": \"DISCOUNT\"\n },\n \"error\": null,\n \"validations\": null\n}"}],"_postman_id":"cbbec6de-4785-436d-89f8-b4c14074da58"},{"name":"Get search recommendations","id":"fae17da2-eaef-4482-9e88-ca9d92be9f68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{domain_name}/api/web/suggestions/query","description":"The Suggestion API offers query recommendations as users type into a search bar. It analyzes the input text and returns a list of relevant suggestions in real time based on user history and other contextual information like category and brand. This feature notably improves the user experience, accelerating the search process and effectively directing users to their intended queries.
\nThe q parameter in the query should include a minimum of 2 characters and a maximum of 280 characters. Otherwise, a validation exception will occur.
\n{ \n \"status\": \"Success\",\n \"data\": [\n {\n \"phrase\": \"...\"\n \"phraseType\": \"...\"\n }, ...\n ],\n \"error\": null,\n \"validations\": null\n}\n\n{ \n \"status\": \"Error\",\n \"data\": null,\n \"redirection\": null,\n \"partnerResources\": null,\n \"error\": {\n \"code\": \"500 INTERNAL_SERVER_ERROR\",\n \"message\": \"...\" \n },\n \"validations\": null,\n \"appliedSearchStrategy\": null \n}\n\n{\n \"status\": \"ValidationException\",\n \"data\": null,\n \"error\": null,\n \"validations\": [\n \"...\"\n ]\n}\n\nRequired. Query String that will be searched.
\n","type":"text/plain"},"key":"q","value":"{SEARCH_QUERY}"},{"disabled":true,"description":{"content":"Required. This is your partner name. Navigate to InOne > InOne Settings > Account Preferences to copy your partner id.
\n","type":"text/plain"},"key":"p","value":""},{"disabled":true,"description":{"content":"Required. Locale is required to get partner products in the current language of the website. E.g. en_US, en_GB
\n","type":"text/plain"},"key":"l","value":"en_US"}],"variable":[]}},"response":[],"_postman_id":"fae17da2-eaef-4482-9e88-ca9d92be9f68"}],"id":"de7e02ce-4ff2-411f-8e30-d7d67bf466a0","description":"Search API allows you to get products that match your search criteria and available facet options to further refine the results.
\n","_postman_id":"de7e02ce-4ff2-411f-8e30-d7d67bf466a0"},{"name":"Reports & Analysis APIs","item":[{"name":"Email","item":[{"name":"Get email campaign list","id":"e4ee8140-16a5-4c4d-a4d1-fef6c4e9132e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"url":"https://analytics.api.useinsider.com/email/v1/campaign/list?page=Integer&perPage=Integer","description":"This request allows you to get the analytics of your email campaigns for a given time period.
\n\n\nThe campaigns on the Draft and Scheduled statuses are not listed in the response.
\n
The following are the query parameters you need to use in your request.
\nBefore sending the request, make sure:
\nThe following response returns if the request is successful.
\n{\n \"currentPage\": 1,\n \"data\": [\n {\n \"id\": 67,\n \"campaignName\": \"My awesome campaign\",\n \"startTime\": \"01-01-2023 12:30:15\"\n },\n {\n \"id\": 66,\n \"campaignName\": \"This is a great campaign\",\n \"startTime\": \"01-12-2022 09:30:17\"\n },\n {\n \"id\": 65,\n \"campaignName\": \"This is a recurring campaign\",\n \"startTime\": \"12-12-2022 12:45:15\"\n },\n {\n \"id\": 64,\n \"campaignName\": \"This is a newsletter\",\n \"startTime\": \"22-07-2022 16:00:01\"\n },\n {\n \"id\": 63,\n \"campaignName\": \"My email campaign\",\n \"startTime\": \"01-01-2022 18:30:00\"\n }\n ],\n \"firstPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=1&perPage=5\",\n \"from\": 0,\n \"lastPage\": 14,\n \"lastPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=14&perPage=5\",\n \"nextPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=2&perPage=5\",\n \"path\": \"/email/v1/campaign/list\",\n \"perPage\": 5,\n \"prevPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=1&perPage=5\",\n \"to\": 0,\n \"total\": 67\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we couldn’t validate the request at the moment. You can try again later.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations:
\nSpecifies the number of pages of email campaigns.
\n","type":"text/plain"},"key":"page","value":"Integer"},{"description":{"content":"Specifies the number of emails to be listed per page.
\n","type":"text/plain"},"key":"perPage","value":"Integer"}],"variable":[]}},"response":[{"id":"491c963e-a03f-44d1-8d18-e657746819f3","name":"Request email campaign list","originalRequest":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).","type":"text"}],"url":{"raw":"https://analytics.api.useinsider.com/email/v1/campaign/list?page=2&perPage=5","protocol":"https","host":["analytics","api","useinsider","com"],"path":["email","v1","campaign","list"],"query":[{"key":"page","value":"2","description":"Specifies the number of pages of email campaigns."},{"key":"perPage","value":"5","description":"Specifies the number of emails to be listed per page."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 May 2023 17:31:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7c53eae37d570784-IAD","enabled":true},{"key":"Content-Encoding","value":"br","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"currentPage\": 2,\n \"data\": [\n {\n \"id\": 1084265,\n \"campaignName\": \"Email 1\",\n \"startTime\": \"05-05-2023 10:09:28\"\n },\n {\n \"id\": 1083699,\n \"campaignName\": \"A great email campaign\",\n \"startTime\": \"29-04-2023 14:05:04\"\n },\n {\n \"id\": 1083536,\n \"campaignName\": \"My amazing email campaign\",\n \"startTime\": \"27-04-2023 15:28:33\"\n },\n {\n \"id\": 1083532,\n \"campaignName\": \"RSS Email\",\n \"startTime\": \"27-04-2023 15:13:11\"\n },\n {\n \"id\": 1083530,\n \"campaignName\": \"Email campaign\",\n \"startTime\": \"27-04-2023 14:34:05\"\n }\n ],\n \"firstPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=1&perPage=5\",\n \"from\": 5,\n \"lastPage\": 38,\n \"lastPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=38&perPage=5\",\n \"nextPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=3&perPage=5\",\n \"path\": \"/email/v1/campaign/list\",\n \"perPage\": 5,\n \"prevPageUrl\": \"https://analytics.useinsider.com/email/v1/campaign/list?page=1&perPage=5\",\n \"to\": 10,\n \"total\": 190\n}"}],"_postman_id":"e4ee8140-16a5-4c4d-a4d1-fef6c4e9132e"},{"name":"Get email campaign list V2","id":"7dbdbbd2-cc87-49f8-89ff-1cc5cc2a458c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"url":"https://analytics.api.useinsider.com/email/v2/campaign/list?page=Integer&perPage=Integer","description":"This request allows you to get the analytics of your email campaigns for a given time period with more metrics than V1.
\n\n\nThe campaigns on the Draft and Scheduled statuses are not listed in the response.
\n
The following are the query parameters you need to use in your request.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in page and perPage with your own values in the required data type.
\nThe following response returns if the request is successful.
\n{\n \"currentPage\": 1,\n \"data\": [\n {\n \"id\": 6648,\n \"name\": \"My Email Campaign\",\n \"tags\": \"marketing\",\n \"type\": \"experiment\",\n \"subject\": \"Here is your experiment\",\n \"senderDomain\": \"@useinsider.com\",\n \"utmParameters\": {\n \"utm_term\": \"\",\n \"utm_medium\": \"email\",\n \"utm_source\": \"insider\",\n \"utm_status\": true,\n \"utm_content\": \"example\",\n \"utm_campaign\": \"insider_0225\"\n },\n \"startTime\": \"05-02-2025 09:00:05\"\n }\n ],\n“firstPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=1&perPage=10”,\n “from”: 0,\n “lastPage”: 79,\n “lastPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=79&perPage=10”,\n “nextPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=2&perPage=10”,\n “path”: “/email/v2/campaign/list”,\n “perPage”: 10,\n “prevPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=1&perPage=10”,\n “to”: 0,\n “total”: 787\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we couldn’t validate the request at the moment. You can try again later.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations:
\nAll functions must be executed with an HTTPS GET request.
\nThe x-ins-auth-key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1 year-range.
\nYou can send 1000 requests/per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nThe perPage value should be between 1-100.
\nSpecifies the number of pages of email campaigns.
\n","type":"text/plain"},"key":"page","value":"Integer"},{"description":{"content":"Specifies the number of emails to be listed per page.
\n","type":"text/plain"},"key":"perPage","value":"Integer"}],"variable":[]}},"response":[],"_postman_id":"7dbdbbd2-cc87-49f8-89ff-1cc5cc2a458c"},{"name":"Get email campaign analytics","id":"25034067-18e9-449b-92bb-8010a33b1939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"url":"https://analytics.api.useinsider.com/email/v1/campaign/statistics?campaignId=integer&startTime=int64","description":"This request allows you to get the analytics of your email campaigns for a given time period.
\n\n\nThe campaigns on the Draft and Scheduled statuses are not listed in the response.
\n
The following are the query parameters you need to use in your request.
\n\n\nIf the endTime value is empty, it will be populated with today’s date and time in UTC.
\n
Before sending the request, make sure:
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"details\": {},\n \"summary\": {\n \"blocks\": 300,\n \"bounces\": 0,\n \"clickRate\": 1.45,\n \"clickToOpen\": 2860,\n \"conversion\": 22,\n \"conversionRate\": 0.01,\n \"delivered\": 235746,\n \"frequencyDrop\": 0,\n \"invalid\": 0,\n \"linkActivities\": [\n {\n \"totalClick\": 1,\n \"uniqueClick\": 1,\n \"url\": \"https://google.com\"\n }\n ],\n \"machineOpen\": 0,\n \"openRate\": 6.48,\n \"revenue\": 0,\n \"sendingDrop\": 0,\n \"sent\": 236573,\n \"spams\": 2,\n \"systemDrop\": 0,\n \"totalClick\": 4931,\n \"totalOpen\": 64518,\n \"uniqueClick\": 3429,\n \"uniqueOpen\": 15272,\n \"unsubscribes\": 100\n }\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we couldn’t validate the request at the moment. You can try again later.
\nSorry, we detected an invalid Campaign ID in your request. The Campaign ID is not found in the database. You can confirm your Campaign ID by checking the InOne panel.
\nSorry, we received an invalid request. We are able to provide the analytics data for only the last 1 year.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with an HTTPS GET request.
\nThe x-ins-auth-key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1 year-range.
\nYou can send 100 requests/per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nThe perPage value should be between 1-100.
\nYour campaign ID that can be found on the campaign URL.
\n","type":"text/plain"},"key":"campaignId","value":"integer"},{"description":{"content":"The time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"disabled":true,"description":{"content":"The current date (today’s date on the payload). It can be customizable according to your use case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"int64"}],"variable":[]}},"response":[{"id":"0c3fcd12-b75a-43dc-83d9-ff6098684fd9","name":"Request email campaign analytics","originalRequest":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).","type":"text"}],"url":{"raw":"https://analytics.api.useinsider.com/email/v1/campaign/statistics?campaignId=2000&startTime=1683726709","protocol":"https","host":["analytics","api","useinsider","com"],"path":["email","v1","campaign","statistics"],"query":[{"key":"campaignId","value":"2000","description":"Your campaign ID that can be found on the campaign URL."},{"key":"startTime","value":"1683726709","description":"The time campaign is being launched. Specifies a 10-digit epoch start time."},{"key":"endTime","value":"int64","description":"The current date (today’s date on the payload). It can be customizable according to your use case. Specifies a 10-digit epoch start time.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 May 2023 13:57:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Set-Cookie","value":"__cf_bm=vGyEoG.yYHgHbceASXMqosYtunUU1OYDfzjjZZbsHm4-1685023030-0-AdKAHZEot48TF9AnLKddAejpa83DwvMeO2139K3m+DCGlV5RQkQIGsxKEEP3V8cSZlUzYKnoj99i1k/IGki6tIs=; path=/; expires=Thu, 25-May-23 14:27:10 GMT; domain=.useinsider.com; HttpOnly; Secure; SameSite=None","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cce49306a20588a-IAD","enabled":true},{"key":"Content-Encoding","value":"br","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"details\": {\n \"4160\": {\n \"blocks\": 0,\n \"bounces\": 0,\n \"clickRate\": 0,\n \"clickToOpen\": 0,\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"delivered\": 12,\n \"frequencyDrop\": 0,\n \"invalid\": 0,\n \"invalidDrop\": 0,\n \"linkActivity\": [],\n \"machineOpen\": 2,\n \"mobileRevenue\": 0,\n \"openRate\": 16.666666666666664,\n \"recommendationRevenue\": 0,\n \"revenue\": 0,\n \"sendingDrop\": 0,\n \"sent\": 12,\n \"spams\": 0,\n \"systemDrop\": 0,\n \"totalClick\": 0,\n \"totalOpen\": 2,\n \"uniqueClick\": 0,\n \"uniqueMachineOpen\": 2,\n \"uniqueOpen\": 2,\n \"unsubscribes\": 0\n }\n },\n \"isp\": [\n {\n \"metrics\": {\n \"blocks\": 0,\n \"bounces\": 0,\n \"clickThroughRate\": 0,\n \"delivered\": 10,\n \"openRate\": 0,\n \"totalClick\": 0,\n \"totalOpen\": 0,\n \"uniqueClick\": 0,\n \"uniqueOpen\": 0\n },\n \"name\": \"name1\"\n },\n {\n \"metrics\": {\n \"blocks\": 0,\n \"bounces\": 0,\n \"clickThroughRate\": 0,\n \"delivered\": 1,\n \"openRate\": 100,\n \"totalClick\": 0,\n \"totalOpen\": 1,\n \"uniqueClick\": 0,\n \"uniqueOpen\": 1\n },\n \"name\": \"name2\"\n },\n {\n \"metrics\": {\n \"blocks\": 0,\n \"bounces\": 0,\n \"clickThroughRate\": 0,\n \"delivered\": 1,\n \"openRate\": 100,\n \"totalClick\": 0,\n \"totalOpen\": 1,\n \"uniqueClick\": 0,\n \"uniqueOpen\": 1\n },\n \"name\": \"name3\"\n }\n ],\n \"summary\": {\n \"blocks\": 0,\n \"bounces\": 0,\n \"clickRate\": 0,\n \"clickToOpen\": 0,\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"delivered\": 12,\n \"frequencyDrop\": 0,\n \"invalid\": 0,\n \"invalidDrop\": 0,\n \"linkActivity\": [],\n \"machineOpen\": 2,\n \"mobileRevenue\": 0,\n \"openRate\": 16.666666666666664,\n \"recommendationRevenue\": 0,\n \"revenue\": 0,\n \"sendingDrop\": 0,\n \"sent\": 12,\n \"spams\": 0,\n \"systemDrop\": 0,\n \"totalClick\": 0,\n \"totalOpen\": 2,\n \"uniqueClick\": 0,\n \"uniqueMachineOpen\": 2,\n \"uniqueOpen\": 2,\n \"unsubscribes\": 0\n }\n }\n}"}],"_postman_id":"25034067-18e9-449b-92bb-8010a33b1939"},{"name":"Get email campaign analytics V2","id":"cc55f6b1-e2b5-45ba-8a69-34a85361b877","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"url":"https://analytics.api.useinsider.com/email/v2/campaign/statistics?campaignId=integer&startTime=int64","description":"This request allows you to get the analytics of your email campaigns for a given time period with more metrics than V1.
\n\n\nThe campaigns on the Draft and Scheduled statuses are not listed in the response.
\n
The following are the query parameters you need to use in your request.
\n\n\nIf the endTime value is empty, it will be populated with today’s date and time in UTC.
\n
Before sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in campaignID, startTime, and endTime with your own values in the required data type.
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"details\": {\n \"1199\": {\n \"sent\": 76982,\n \"delivered\": 75999,\n \"deliveryRate\": 98.72307812215843,\n \"openRate\": 19.88315635732049,\n \"totalOpens\": 18763,\n \"uniqueOpens\": 15111,\n \"clickThroughRate\": 0.3710575139146568,\n \"totalClicks\": 581,\n \"uniqueClicks\": 282,\n \"clickToOpenRate\": 1.8661901925749453,\n \"conversions\": 5,\n \"conversionRate\": 0.0065790339346570356,\n \"revenue\": 337.56999588012695,\n \"unsubscribe\": 131,\n \"bounce\": 9,\n \"bounceRate\": 0.0116910446597906,\n \"blocks\": 1166,\n \"spamReports\": 7,\n \"uniqueUserOpens\": 4098,\n \"uniqueUserOpenRate\": 5.392176212844906,\n \"uniqueMachineOpens\": 11013,\n \"uniqueMachineOpenRate\": 14.490980144475586,\n \"systemDrops\": 0,\n \"sendingDrops\": 1899,\n \"frequencyDrop\": 0,\n \"unsubscribeDrop\": 712,\n \"spamDrop\": 0,\n \"invalidDrop\": 0,\n \"bounceDrop\": 5,\n \"linkClickActivity\": [\n {\n \"totalClick\": 94,\n \"uniqueClick\": 73,\n \"link\": \"https://www.insider.com/products\"\n },\n {\n \"totalClick\": 89,\n \"uniqueClick\": 71,\n \"link\": \"https://www.insider.com/collections/c\"\n },\n {\n \"totalClick\": 9,\n \"uniqueClick\": 6,\n \"link\": \"https://www.insider.com/collections/f\"\n }\n ],\n \"utmParameters\": \"{\\\"utm_source\\\":\\\"insider\\\",\\\"utm_medium\\\":\\\"email\\\",\\\"utm_campaign\\\":\\\"insider_2025\\\",\\\"utm_term\\\":\\\"\\\",\\\"utm_content\\\":\\\"\\\",\\\"utm_status\\\":true}\"\n }\n },\n \"isp\": [\n {\n \"name\": \"gmail\",\n \"metrics\": {\n \"blocks\": 283,\n \"bounces\": 4,\n \"clickThroughRate\": 0.1826458356749466,\n \"delivered\": 35588,\n \"openRate\": 10.006181859053614,\n \"spams\": 0,\n \"totalClick\": 91,\n \"totalOpen\": 4854,\n \"uniqueClick\": 65,\n \"uniqueOpen\": 3561,\n \"unsubscribes\": 33\n }\n },\n {\n \"name\": \"hotmail\",\n \"metrics\": {\n \"blocks\": 139,\n \"bounces\": 0,\n \"clickThroughRate\": 0.3071253071253071,\n \"delivered\": 14652,\n \"openRate\": 28.77422877422877,\n \"spams\": 1,\n \"totalClick\": 51,\n \"totalOpen\": 4796,\n \"uniqueClick\": 45,\n \"uniqueOpen\": 4216,\n \"unsubscribes\": 24\n }\n },\n {\n \"name\": \"orange\",\n \"metrics\": {\n \"blocks\": 17,\n \"bounces\": 0,\n \"clickThroughRate\": 1.0698096101541252,\n \"delivered\": 5515,\n \"openRate\": 31.677243880326383,\n \"spams\": 0,\n \"totalClick\": 117,\n \"totalOpen\": 2269,\n \"uniqueClick\": 59,\n \"uniqueOpen\": 1747,\n \"unsubscribes\": 16\n }\n },\n {\n \"name\": \"yahoo\",\n \"metrics\": {\n \"blocks\": 6,\n \"bounces\": 2,\n \"clickThroughRate\": 0.690376569037657,\n \"delivered\": 4780,\n \"openRate\": 31.23430962343096,\n \"spams\": 1,\n \"totalClick\": 44,\n \"totalOpen\": 1789,\n \"uniqueClick\": 33,\n \"uniqueOpen\": 1493,\n \"unsubscribes\": 14\n }\n },\n {\n \"name\": \"icloud\",\n \"metrics\": {\n \"blocks\": 128,\n \"bounces\": 0,\n \"clickThroughRate\": 0.17921146953405018,\n \"delivered\": 1674,\n \"openRate\": 46.415770609319,\n \"spams\": 0,\n \"totalClick\": 3,\n \"totalOpen\": 913,\n \"uniqueClick\": 3,\n \"uniqueOpen\": 777,\n \"unsubscribes\": 2\n }\n },\n {\n \"name\": \"free\",\n \"metrics\": {\n \"blocks\": 57,\n \"bounces\": 0,\n \"clickThroughRate\": 0.5847953216374269,\n \"delivered\": 1539,\n \"openRate\": 30.734243014944767,\n \"spams\": 0,\n \"totalClick\": 11,\n \"totalOpen\": 599,\n \"uniqueClick\": 9,\n \"uniqueOpen\": 473,\n \"unsubscribes\": 7\n }\n },\n {\n \"name\": \"msn\",\n \"metrics\": {\n \"blocks\": 4,\n \"bounces\": 0,\n \"clickThroughRate\": 0,\n \"delivered\": 264,\n \"openRate\": 27.65151515151515,\n \"spams\": 0,\n \"totalClick\": 0,\n \"totalOpen\": 85,\n \"uniqueClick\": 0,\n \"uniqueOpen\": 73,\n \"unsubscribes\": 0\n }\n },\n {\n \"name\": \"bbox\",\n \"metrics\": {\n \"blocks\": 10,\n \"bounces\": 1,\n \"clickThroughRate\": 0.5524861878453038,\n \"delivered\": 181,\n \"openRate\": 17.12707182320442,\n \"spams\": 0,\n \"totalClick\": 1,\n \"totalOpen\": 41,\n \"uniqueClick\": 1,\n \"uniqueOpen\": 31,\n \"unsubscribes\": 0\n }\n }\n ]\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we couldn’t validate the request at the moment. You can try again later.
\nSorry, we detected an invalid Campaign ID in your request. The Campaign ID is not found in the database. You can confirm your Campaign ID by checking the InOne panel.
\nSorry, we received an invalid request. We are able to provide the analytics data for only the last 1 year.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with an HTTPS GET request.
\nThe x-ins-auth-key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1 year-range.
\nYou can send 100 requests/per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nThe perPage value should be between 1-100.
\nYour campaign ID that can be found on the campaign URL.
\n","type":"text/plain"},"key":"campaignId","value":"integer"},{"description":{"content":"The time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"disabled":true,"description":{"content":"The current date (today’s date on the payload). It can be customizable according to your use case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"int64"}],"variable":[]}},"response":[],"_postman_id":"cc55f6b1-e2b5-45ba-8a69-34a85361b877"},{"name":"Get overall analytics","id":"9afeb0ff-a180-493f-bd14-296207bca861","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"url":"https://analytics.api.useinsider.com/email/v1/overall?startTime=int64&endTime=int64","description":"This request allows you to get the overall analytics of your email campaigns for a given time period
\n\n\nThe campaigns on the Draft and Scheduled statuses are not listed in the response.
\n
The following are the query parameters you need to use in your request.
\nBefore sending the request, make sure:
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"summary\": {\n \"blocks\": 0,\n \"bounceDrop\": 0,\n \"bounces\": 0,\n \"clickRate\": 5.88,\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"delivered\": 17,\n \"frequencyDrop\": 0,\n \"invalid\": 0,\n \"invalidDrop\": 0,\n \"machineOpen\": 0,\n \"openRate\": 47.05,\n \"revenue\": 0,\n \"sendingDrop\": 0,\n \"sent\": 27,\n \"spamDrop\": 0,\n \"spams\": 0,\n \"systemDrop\": 0,\n \"totalClick\": 1,\n \"totalOpen\": 15,\n \"unsubscribeDrop\": 0,\n \"unsubscribes\": 0\n },\n \"linkActivities\": [\n {\n \"totalClick\": 1,\n \"uniqueClick\": 1,\n \"url\": \"https://google.com\"\n }\n ]\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we couldn’t validate the request at the moment. You can try again later.
\nRate limited
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations:
\nAll functions must be executed with an HTTPS GET request.
\nThe x-ins-auth-key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1 year-range.
\nYou can send 100 requests/per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nThe perPage value should be between 1-100.
\nThe time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"description":{"content":"The current date (today’s date on the payload). It can be customizable according to your case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"int64"}],"variable":[]}},"response":[{"id":"85eaa7ab-54d4-46e2-81b2-99a0ac1713fe","name":"Request overall analytics","originalRequest":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).","type":"text"}],"url":{"raw":"https://analytics.api.useinsider.com/email/v1/overall?startTime=1683731363&endTime=1685027363","protocol":"https","host":["analytics","api","useinsider","com"],"path":["email","v1","overall"],"query":[{"key":"startTime","value":"1683731363","description":"The time campaign is being launched. Specifies a 10-digit epoch start time."},{"key":"endTime","value":"1685027363","description":"The current date (today’s date on the payload). It can be customizable according to your case. Specifies a 10-digit epoch start time."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 May 2023 15:10:34 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7cceb4b77d572012-IAD","enabled":true},{"key":"Content-Encoding","value":"br","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"summary\": {\n \"blocks\": 4791,\n \"bounceDrop\": 0,\n \"bounces\": 0,\n \"clickRate\": 0.7633587786259541,\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"delivered\": 43261,\n \"frequencyDrop\": 0,\n \"invalid\": 0,\n \"invalidDrop\": 0,\n \"machineOpen\": 2,\n \"openRate\": 6.106870229007633,\n \"revenue\": 0,\n \"sendingDrop\": 4792,\n \"sent\": 48053,\n \"spamDrop\": 0,\n \"spams\": 1,\n \"systemDrop\": 0,\n \"totalClick\": 2,\n \"totalOpen\": 12,\n \"uniqueClick\": 1,\n \"uniqueMachineOpen\": 2,\n \"uniqueOpen\": 8,\n \"unsubscribeDrop\": 0,\n \"unsubscribes\": 3\n },\n \"linkActivities\": [\n {\n \"totalClick\": 2,\n \"uniqueClick\": 1,\n \"url\": \"https://mycampaign.useinsider\"\n }\n ]\n }\n}"}],"_postman_id":"9afeb0ff-a180-493f-bd14-296207bca861"},{"name":"Get overall analytics V2","id":"bfa4c7f9-e092-40c0-934e-c747294e2761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"}],"url":"https://analytics.api.useinsider.com/email/v2/overall?startTime=int64&endTime=int64","description":"This request allows you to get the overall analytics of your email campaigns for a given time period with more metrics than V1.
\n\n\nThe campaigns on the Draft and Scheduled statuses are not listed in the response.
\n
The following are the query parameters you need to use in your request.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in start_date and end_date with your own values in the required data type.
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"summary\": {\n \"sent\": 28177222,\n \"delivered\": 27174347,\n \"deliveryRate\": 96.44083082427359,\n \"openRate\": 15.377410908898751,\n \"totalOpens\": 5028722,\n \"uniqueOpens\": 4178711,\n \"clickThroughRate\": 0.10888946107886237,\n \"totalClicks\": 291619,\n \"uniqueClicks\": 29590,\n \"clickToOpenRate\": 0.708113099948764,\n \"conversions\": 365,\n \"conversionRate\": 0.0013431785499758283,\n \"revenue\": 54860988,\n \"unsubscribe\": 5083,\n \"bounce\": 2238,\n \"bounceRate\": 0.007942585681441554,\n \"blocks\": 1013573,\n \"spamReports\": 480,\n \"uniqueUserOpens\": 1216549,\n \"uniqueUserOpenRate\": 4.4768288268343674,\n \"uniqueMachineOpens\": 2962162,\n \"uniqueMachineOpenRate\": 10.900582082064382,\n \"systemDrops\": 541566,\n \"sendingDrops\": 1558662,\n \"frequencyDrop\": 0,\n \"unsubscribeDrop\": 533725,\n \"spamDrop\": 22,\n \"invalidDrop\": 12,\n \"bounceDrop\": 8612\n },\n \"linkActivities\": [\n {\n \"totalClick\": 9908,\n \"uniqueClick\": 5923,\n \"link\": \"https://sample.useinsider.com/download\"\n },\n {\n \"totalClick\": 379,\n \"uniqueClick\": 109,\n \"link\": \"https://sample.useinsider.com/download/v\"\n },\n {\n \"totalClick\": 378,\n \"uniqueClick\": 116,\n \"link\": \"https://sample.useinsider.com/download_insider\"\n },\n {\n \"totalClick\": 378,\n \"uniqueClick\": 115,\n \"link\": \"https://sample.useinsider.com/download_useinsider\"\n },\n {\n \"totalClick\": 375,\n \"uniqueClick\": 113,\n \"link\": \"https://sample.useinsider.com/download_open\"\n }\n ],\n \"topEmailClients\": {\n \"android\": 0.46,\n \"apple-mail\": 0.1,\n \"g-mail\": 84.54,\n \"i-pad\": 0.02,\n \"i-phone\": 0.08,\n \"other\": 7.56,\n \"other-web-mail\": 0.05,\n \"outlook\": 0.01,\n \"yahoo\": 7.19\n },\n \"topEmailDevices\": {\n \"desktop\": 0.13,\n \"mobile\": 0.53,\n \"others\": 7.57,\n \"tablet\": 0.07,\n \"web-mail\": 91.7\n }\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we couldn’t validate the request at the moment. You can try again later.
\nRate limited
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations:
\nAll functions must be executed with an HTTPS GET request.
\nThe x-ins-auth-key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1 year-range.
\nYou can send 100 requests/per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nThe perPage value should be between 1-100.
\nThe time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"description":{"content":"The current date (today’s date on the payload). It can be customizable according to your case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"int64"}],"variable":[]}},"response":[],"_postman_id":"bfa4c7f9-e092-40c0-934e-c747294e2761"}],"id":"7b47187a-1b86-4448-b919-1b39f39ee94f","description":"Email Analytics APIs enable you to get your email campaign list, email campaign analytics, and overall email analytics from your back-end without using Insider's platform.
\n","_postman_id":"7b47187a-1b86-4448-b919-1b39f39ee94f"},{"name":"Web Push","item":[{"name":"Get web push top metrics analytics","id":"84e062f9-afbf-474f-9a65-bdad6963be9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"YOURPARTNERID\",\n \"start_date\" : \"2023-06-01\",\n \"end_date\" : \"2023-06-08\"\n}"},"url":"https://web-push.api.useinsider.com/v1/statistics/top-metrics","description":"Insider's web push API allows you to get the campaigns analytics of your web push notifications from your own back-end without using the Insider's InOne panel. This API returns top metric analytics (without campaign information) in the given time interval in API request payload.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in partner_id, start_date, and end_date with your own values in the required data type.
\ncurl --location --request POST 'https://web-push.api.useinsider.com/v1/statistics/top-metrics' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data '{\n \"partner_id\": \"YOURPARTNERID\",\n \"start_date\" : \"2023-06-01\",\n \"end_date\" : \"2023-06-08\"\n}'\n\n{\n \"overview\": {\n \"total\": {\n \"targeted\": \"9,550,384\",\n \"deliveryRate\": \"32.42%\",\n \"ctr\": \"0.76%\",\n \"conversionRate\": \"0.01%\"\n },\n \"targeted\": {\n \"sent\": \"9,505,769\",\n \"dropped\": \"44,615\"\n },\n \"deliveryRate\": {\n \"delivered\": \"3,082,158\",\n \"undelivered\": \"6,423,611\"\n },\n \"ctr\": {\n \"clicks\": \"23,419\"\n },\n \"conversionRate\": {\n \"conversions\": \"3\"\n },\n \"revenue\": \"2,480 TRY\"\n },\n \"performance\": [\n {\n \"label\": \"Bulk\",\n \"campaignCount\": 22,\n \"deliveryRate\": \"32.42\",\n \"ctr\": \"0.76\",\n \"conversionRate\": \"0.01\",\n \"revenue\": \"2479.6600112915\"\n },\n {\n \"label\": \"In Stock Alert\",\n \"campaignCount\": 4,\n \"deliveryRate\": \"0.00\",\n \"ctr\": \"0.00\",\n \"conversionRate\": \"0.00\",\n \"revenue\": \"0\"\n },\n {\n \"label\": \"Segment\",\n \"campaignCount\": 2,\n \"deliveryRate\": \"0.00\",\n \"ctr\": \"0.00\",\n \"conversionRate\": \"0.00\",\n \"revenue\": \"0\"\n },\n {\n \"label\": \"Cart Reminder\",\n \"campaignCount\": 4,\n \"deliveryRate\": \"0.00\",\n \"ctr\": \"0.00\",\n \"conversionRate\": \"0.00\",\n \"revenue\": \"0\"\n },\n {\n \"label\": \"Price Alert\",\n \"campaignCount\": 6,\n \"deliveryRate\": \"0.00\",\n \"ctr\": \"0.00\",\n \"conversionRate\": \"0.00\",\n \"revenue\": \"0\"\n },\n {\n \"label\": \"Trigger\",\n \"campaignCount\": 10,\n \"deliveryRate\": \"0.00\",\n \"ctr\": \"0.00\",\n \"conversionRate\": \"0.00\",\n \"revenue\": \"0\"\n }\n ],\n \"dropped\": [\n {\n \"label\": \"frequencyCapped\",\n \"count\": \"0\",\n \"percentage\": \"0.00\"\n },\n {\n \"label\": \"silentHours\",\n \"count\": \"0\",\n \"percentage\": \"0.00\"\n },\n {\n \"label\": \"unsubscriptions\",\n \"count\": \"44,203\",\n \"percentage\": \"99.08\"\n },\n {\n \"label\": \"serviceProviderErrors\",\n \"count\": \"412\",\n \"percentage\": \"0.92\"\n },\n {\n \"label\": \"internalErrors\",\n \"count\": \"0\",\n \"percentage\": \"0.00\"\n }\n ],\n \"undelivered\": [\n {\n \"label\": \"offlineRecipients\",\n \"count\": \"6,413,534\",\n \"percentage\": \"99.84\"\n },\n {\n \"label\": \"other\",\n \"count\": \"10,077\",\n \"percentage\": \"0.16\"\n }\n ]\n}\n\n{\n \"status_code\": 401\n}\n\n{\n \"status_code\": 422,\n \"errors\": {\n \"end_date\": [\n \"The end date does not match the format Y-m-d.\"\n ]\n }\n}\n\n400: Bad request
\n401: Unauthorized request
\n403: Request limit exceeded
\n422: Missing parameter
\nAll functions must be executed with an HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can make 30 requests per minute in aggregate. Every response you receive from the API will include two additional headers specifying the number of requests that have been used and the maximum number of requests available for your account.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"YOURPARTNERID\",\n \"start_date\" : \"2023-06-01\",\n \"end_date\" : \"2023-06-08\",\n \"per_page\" : \"100\",\n\n\"page\" : \"1\"\n}"},"url":"https://web-push.api.useinsider.com/v1/statistics/overall-metrics","description":"Insider's web push API allows you to get the campaigns analytics of your web push notifications from your own back-end without using the Insider's InOne panel. This API returns overall metric analytics with campaign information in the given time interval in API request payload.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in partner_id, start_date, and end_date with your own values in the required data type.
\ncurl --location --POST 'https://web-push.api.useinsider.com/v1/statistics/overall-metrics' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data '{\n \"partner_id\": \"YOURPARTNERID\",\n \"start_date\": \"2023-12-02\",\n \"end_date\": \"2023-12-19\"\n \"page\": 1,\n \"per_page\": 10\n}'\n\n{\n \"page\": 1,\n \"per_page\": 2,\n \"total\": 48,\n \"data\": [\n {\n \"id\": 12345,\n \"tags\": [\n \"Discount\",\n \"Baby\",\n \"Powder\"\n ],\n \"type\": \"Bulk\",\n \"campName\": \"08.06.2023-2100-BabyCare\",\n \"status\": \"Active\",\n \"builderId\": 11111,\n \"sendDate\": \"2023-06-08 21:15:10\",\n \"startDate\": \"2023-06-08 21:15:00\",\n \"endDate\": \"2023-06-08 21:15:00\",\n \"daysActive\": 1,\n \"messageLink\": \"https://sample.useinsider.com/discount/all-baby-care-products\",\n \"firstButtonLink\": \"N/A\",\n \"secondButtonLink\": \"N/A\",\n \"targeted\": 411840,\n \"sent\": 411344,\n \"dropped\": 496,\n \"deliveryRate\": 0.340792621261037,\n \"delivered\": 140183,\n \"undelivered\": 271161,\n \"ctr\": 0.005157544067397616,\n \"clicks\": 723,\n \"conversionRate\": 0,\n \"conversions\": 0,\n \"revenue\": 0\n },\n {\n \"id\": 22222,\n \"tags\": [\n \"Baby\"\n ],\n \"type\": \"Bulk\",\n \"campName\": \"08.06.2023-Bebekcom-BabyProducts\",\n \"status\": \"Active\",\n \"builderId\": 10101,\n \"sendDate\": \"2023-06-08 16:00:27\",\n \"startDate\": \"2023-06-08 16:00:00\",\n \"endDate\": \"2023-06-08 16:00:00\",\n \"daysActive\": 1,\n \"messageLink\": \"https://sample.useinsider.com/baby-products/\",\n \"firstButtonLink\": \"N/A\",\n \"secondButtonLink\": \"N/A\",\n \"targeted\": 411733,\n \"sent\": 411279,\n \"dropped\": 454,\n \"deliveryRate\": 0.3351933845394489,\n \"delivered\": 137858,\n \"undelivered\": 273421,\n \"ctr\": 0.008399947772345456,\n \"clicks\": 1158,\n \"conversionRate\": 0,\n \"conversions\": 0,\n \"revenue\": 0\n }\n ]\n}\n\n{\n \"status_code\": 401\n}\n\n{\n \"status_code\": 422,\n \"errors\": {\n \"end_date\": [\n \"The end date does not match the format Y-m-d.\"\n ]\n }\n}\n\n400: Bad request
\n401: Unauthorized request
\n403: Request limit exceeded
\n422: Missing parameter
\nAll functions must be executed with an HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can make 30 requests per minute in aggregate. Every response you receive from the API will include two additional headers specifying the number of requests that have been used and the maximum number of requests available for your account.
\nThis key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"YOURPARTNERID\",\n \"start_date\" : \"2023-06-01\",\n \"end_date\" : \"2023-06-08\",\n\n\"campaign_id\" : \"11111\"\n}"},"url":"https://web-push.api.useinsider.com/v1/statistics/campaign-metrics","description":"Insider's web push API allows you to get the campaigns analytics of your web push notifications from your own back-end without using the Insider's InOne panel. This API returns analytics specific to a single campaign in the given time interval in API request payload.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in partner_id, start_date, end_date, and campaign_id with your own values in the required data type.
\n\ncurl --location --POST 'https://web-push.api.useinsider.com/v1/statistics/campaign-metrics' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{vault:bearer-token}}' \\\n--data '{\n \"partner_id\": \"YOURPARTNERID\",\n \"start_date\" : \"2023-06-01\",\n \"end_date\" : \"2023-06-08\",\n\n\"campaign_id\" : \"11111\"\n}'\n\n{\n \"name\": \"08.06.2023-2100\",\n \"primaryGoal\": \"salesFromClick\",\n \"startDate\": \"2023-05-31T21:00:00.000000Z\",\n \"endDate\": \"2023-06-08T20:59:59.999999Z\",\n \"isRecurring\": false,\n \"alias\": \"bulk\",\n \"preferredCurrency\": \"USD\",\n \"personalizationStatus\": \"Active\",\n \"isTTLEnded\": true,\n \"goalMenu\": {\n \"camp-join\": \"Clicks\",\n \"sales-from-click\": \"Purchases From Click...\"\n },\n \"overview\": {\n \"total\": {\n \"targeted\": \"411,840\",\n \"deliveryRate\": \"34.08%\",\n \"ctr\": \"0.52%\",\n \"conversionRate\": \"0.00%\"\n },\n \"targeted\": {\n \"sent\": \"411,344\",\n \"dropped\": \"496\"\n },\n \"deliveryRate\": {\n \"delivered\": \"140,183\",\n \"undelivered\": \"271,161\"\n },\n \"ctr\": {\n \"clicks\": \"723\"\n },\n \"conversionRate\": {\n \"conversions\": \"0\"\n },\n \"revenue\": \"0 USD\"\n },\n \"deviceMetrics\": [\n {\n \"device\": \"Desktop\",\n \"sent\": \"36,752\",\n \"delivered\": \"3,077\",\n \"deliveryRate\": \"8.37%\",\n \"clicks\": \"4\",\n \"ctr\": \"0.13%\",\n \"conversions\": \"0\",\n \"conversionRate\": \"0.00%\",\n \"revenue\": \"USD\"\n },\n {\n \"device\": \"Mobile\",\n \"sent\": \"374,592\",\n \"delivered\": \"137,106\",\n \"deliveryRate\": \"36.60%\",\n \"clicks\": \"719\",\n \"ctr\": \"0.52%\",\n \"conversions\": \"0\",\n \"conversionRate\": \"0.00%\",\n \"revenue\": \"0 USD\"\n }\n ],\n \"clickMetrics\": [\n {\n \"name\": \"mainAction\",\n \"header\": \"Main Element\",\n \"clicks\": \"723\",\n \"clickRatio\": \"100.00%\"\n },\n {\n \"name\": \"primaryAction\",\n \"header\": \"\",\n \"clicks\": \"0\",\n \"clickRatio\": \"0.00%\"\n },\n {\n \"name\": \"secondaryAction\",\n \"header\": \"\",\n \"clicks\": \"0\",\n \"clickRatio\": \"0.00%\"\n }\n ],\n \"unsuccessfulMessages\": {\n \"dropped\": [\n {\n \"label\": \"frequencyCapped\",\n \"count\": \"0\",\n \"percentage\": \"0.00\"\n },\n {\n \"label\": \"silentHours\",\n \"count\": \"0\",\n \"percentage\": \"0.00\"\n },\n {\n \"label\": \"unsubscriptions\",\n \"count\": \"453\",\n \"percentage\": \"91.33\"\n },\n {\n \"label\": \"serviceProviderErrors\",\n \"count\": \"43\",\n \"percentage\": \"8.67\"\n },\n {\n \"label\": \"internalErrors\",\n \"count\": \"0\",\n \"percentage\": \"0.00\"\n }\n ],\n \"undelivered\": [\n {\n \"label\": \"offlineRecipients\",\n \"count\": \"270,807\",\n \"percentage\": \"99.87\"\n },\n {\n \"label\": \"other\",\n \"count\": \"354\",\n \"percentage\": \"0.13\"\n }\n ]\n },\n \"comparisonData\": []\n}\n\n{\n \"status_code\": 401\n}\n\n{\n \"status_code\": 422,\n \"errors\": {\n \"end_date\": [\n \"The end date does not match the format Y-m-d.\"\n ]\n }\n}\n\n400: Bad request
\n401: Unauthorized request
\n403: Request limit exceeded
\n422: Missing parameter
\nAll functions must be executed with an HTTPS POST request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can make 30 requests per minute in aggregate. Every response you receive from the API will include two additional headers specifying the number of requests that have been used and the maximum number of requests available for your account.
\nThis header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"{mobileAppApiKey}\"\n}"},"url":"https://mobile.useinsider.com/api/v1/notification/get_statistics","description":"You can use this service to get the analytics of the single push notifications that are sent in the current day using a predefined web service. These analytics include the campaigns created from the beginning of the day (00:00) to the time of the API request. For instance, if you send a request at 14:50, the API will return the campaigns created between 00:00-14:50.
\nThe following is a sample body to send this request.
\n{\n \"api_key\": \"Your API Key goes here\"\n}\n\nThe following response returns if the request is successful.
\n{\n \"campaigns\": [\n {\n \"id\": 5125,\n \"name\": \"My app push name\",\n \"delivery_count\": 1640069,\n \"session_count\": 1085,\n \"open_rate\": \"% 0.07\",\n \"message\": \"This is my message\",\n \"title\": \"This is my title\",\n \"segment_name\": \"This is my segment\",\n \"deep_link\": {\n \"dl_key1\": \"value1\",\n \"dl_key2\": \"value2\"\n },\n \"push_image\": \"https://pushimage1.useinsider.com\"\n },\n {\n \"id\": 5126,\n \"name\": \"My app push name 2\",\n \"delivery_count\": 683618,\n \"session_count\": 914,\n \"open_rate\": \"% 0.13\",\n \"message\": \"This is my message\",\n \"title\": \"This is my title\",\n \"segment_name\": \"English_lang_users\",\n \"deep_link\": {\n \"dl_key3\": \"value3\",\n \"dl_key4\": \"value4\"\n },\n \"push_image\": \"https://pushimage2.useinsider.com\"\n }\n ],\n \"total_camp_count\": 2,\n \"total_delivery_count\": 2323687,\n \"total_session_count\": 1999,\n \"total_open_rate\": \"% 0.09\"\n}\n\nThe successful response returns the following metrics:
\nThe following response returns if the API Key is invalid or incorrect.
\n{\n \"error\": \"Bad Api Key.\"\n}\n\nThe following response returns if the API Key is empty.
\nApi key can not be empty.\n\nWhen sending your request, make sure to follow these limitations.
\nAll functions must be executed with a simple HTTPS POST request.
\nThe API key should be provided in the request body. If the key is incorrect, no operation will be executed.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"iid\",\n \"udid\",\n \"pn\",\n \"uuid\",\n \"em\",\n \"app_version\",\n \"mo\",\n \"ov\"\n ],\n \"events\": {\n \"start_date\": 1693907940,\n \"end_date\": 1693994340,\n \"wanted\": [\n {\n \"event_name\": \"push_delivered\",\n \"params\": [\n \"timestamp\",\n \"camp_id\",\n \"camp_type\",\n \"variant_id\"\n ]\n },\n {\n \"event_name\": \"push_session\",\n \"params\": [\n \"timestamp\",\n \"camp_id\",\n \"camp_type\",\n \"variant_id\"\n ]\n }\n ]\n },\n \"format\": \"csv\",\n \"hook\": \"xyz.test.com\"\n}"},"url":"https://unification.useinsider.com/api/raw/v1/export","description":"Export Raw User Data API prepares the raw data for events and attributes together, and also allows you to export App Push results for multiple requested events and attributes of a user (e.g. name, phone number, age, city, etc.) into Insider's AWS S3 bucket. The request returns a link to partner's webhook endpoint, and this link enables you to have access to the raw user data and transfer it to your end.
\nWhen you deliver an app push to a user and they click it, these actions trigger the push_delivered and push_session events respectively along with their timestamp, camp ID, camp type, and variant ID event parameters. These events and their parameters are listed on the respective user's User Profile.
\n\nSuggested Reading: Understanding Events and Attributes
\n
You should provide a webhook endpoint in the request to be notified when the export link is ready. After sending a request, your webhook endpoint receives an export link as follows to have access to the raw user data.
\nhttps://insider-data-export.useinsider.com/{partner name}/p/{file name}
You can export raw user data in the following use cases:
\nBefore starting the implementation, make sure to share the following information with your Insider Technical Account Manager:
\nYou can consult your Insider Technical Account Manager on which parameters to add in the request.
\nThe sample below displays a request to get the app template results along with raw user data (e.g. insider ID (iid), unique device ID (udid), phone number (pn), unique user ID (uuid), email (em), app version, model (mo), device software version (ov)).
\n{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"iid\",\n \"udid\",\n \"pn\",\n \"uuid\",\n \"em\",\n \"app_version\",\n \"mo\",\n \"ov\"\n ],\n \"events\": {\n \"start_date\": 1693907940,\n \"end_date\": 1693994340,\n \"wanted\": [\n {\n \"event_name\": \"push_delivered\",\n \"params\": [\n \"timestamp\",\n \"camp_id\",\n \"camp_type\",\n \"variant_id\"\n ]\n },\n {\n \"event_name\": \"push_session\",\n \"params\": [\n \"timestamp\",\n \"camp_id\",\n \"camp_type\",\n \"variant_id\"\n ]\n }\n ]\n },\n \"format\": \"csv\",\n \"hook\": \"xyz.test.com\"\n}\n\nWhen the data is ready to download, you will receive the export link on your webhook URL as displayed below.
\n{\"url\":\"https://insider-data-export.useinsider.com/{partner name}/p/{file name}\"}\n\n\n\nIf a user has performed the requested event(s) N times, that user will be displayed in N rows in the exported file. However, since attributes always display the latest information of the user, the attributes on N rows will be the same.
\n
If you exceed the rate limits, you receive an error shown below.
\n{\n \"error\": \"rejected: too many requests\"\n}\n\nDepending on your request, you might also receive 400 Empty Partner, 400 Empty Token, or 403 Authentication Failed responses.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"iid\",\n \"udid\",\n \"pn\",\n \"uuid\",\n \"em\",\n \"app_version\",\n \"mo\",\n \"ov\"\n ],\n \"events\": {\n \"start_date\": 1693907940,\n \"end_date\": 1693994340,\n \"wanted\": [\n {\n \"event_name\": \"inapp_seen\",\n \"params\": [\n \"timestamp\",\n \"inapp_id\",\n \"variant_id\",\n \"dismiss_type\"\n ]\n }\n ]\n },\n \"format\": \"csv\",\n \"hook\": \"xyz.test.com\"\n}"},"url":"https://unification.useinsider.com/api/raw/v1/export","description":"Export Raw User Data API prepares the raw data for events and attributes together, and also allows you to export App Template results for multiple requested events and attributes of a user (e.g. name, phone number, age, city, etc.) into Insider's AWS S3 bucket. The request returns a link to partner's webhook endpoint, and this link enables you to have access to the raw user data and transfer it to your end.
\nWhen a user sees an app template, this action triggers the inapp_seen event respectively along with its timestamp, inapp ID, variant ID, and dismiss type event parameters. These events and their parameters can be listed on the respective user's User Profile.
\n\nSuggested Reading: Understanding Events and Attributes
\n
You should provide a webhook endpoint in the request to be notified when the export link is ready. After sending a request, your webhook endpoint receives an export link as follows to have access to the raw user data.
\nhttps://insider-data-export.useinsider.com/{partner name}/p/{file name}
You can export raw user data in the following use cases:
\nBefore starting the implementation, make sure to share the following information with your Insider Technical Account Manager:
\nYou can consult your Insider Technical Account Manager on which parameters to add in the request.
\nThe sample below displays a request to get the app template results along with raw user data (e.g. insider ID (iid), unique device ID (udid), phone number (pn), unique user ID (uuid), email (em), app version, model (mo), device software version (ov)).
\n{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\": [\n \"iid\",\n \"udid\",\n \"pn\",\n \"uuid\",\n \"em\",\n \"app_version\",\n \"mo\",\n \"ov\"\n ],\n \"events\": {\n \"start_date\": 1693907940,\n \"end_date\": 1693994340,\n \"wanted\": [\n {\n \"event_name\": \"inapp_seen\",\n \"params\": [\n \"timestamp\",\n \"inapp_id\",\n \"variant_id\",\n \"dismiss_type\"\n ]\n }\n ]\n },\n \"format\": \"csv\",\n \"hook\": \"xyz.test.com\"\n}\n\nWhen the data is ready to download, you will receive the export link on your webhook URL as displayed below.
\n{\"url\":\"https://insider-data-export.useinsider.com/{partner name}/p/{file name}\"}\n\n\n\nIf a user has performed the requested event(s) N times, that user will be displayed in N rows in the exported file. However, since attributes always display the latest information of the user, the attributes on N rows will be the same.
\n
If you exceed the rate limits, you receive an error shown below.
\n{\n \"error\": \"rejected: too many requests\"\n}\nDepending on your request, you might also receive 400 Empty Partner, 400 Empty Token, or 403 Authentication Failed responses.
\nAll functions must be executed with a simple HTTPS POST request.
\nOnly a response that states if the request is successful or failed can be received via this API. No data can be inserted.
\nThe request token should be provided on the request header. If the token is incorrect, the operation will not be executed.
\nThe exported data can be in CSV, Parquet or JSON formats.
\nThe export link expires in 24 hours after it is ready.
\nThe rate limit is 1 request per day. The API can be called only once in 24 hours with respect to the UTC time zone. The limitation timeline resets at UTC 00:00.
\nThe value of X-PARTNER-NAME header should be lowercase.
\nThis is your partner name. Navigate to Inone > Inone Settings > Account Preferences to copy your partner name.
\n","type":"text"},{"key":"X-REQUEST-TOKEN","value":"","description":"This key is required to authorize your request. Navigate to Inone > Inone Settings > Integration Settings to generate your request token (API key).
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This header specifies the media type of the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\":[\n \"iid\",\n \"udid\",\n \"pn\",\n \"uuid\",\n \"em\",\n \"app_version\",\n \"mo\",\n \"ov\"\n ],\n \"events\":{\n \"start_date\":1606311893,\n \"end_date\":1611582293,\n \"wanted\":[\n {\n \"event_name\":\"survey_result\",\n \"params\":[\n \"timestamp\",\n \"answer\",\n \"camp_id\",\n \"question\",\n \"variant_id\"\n ]\n }\n ]\n },\n \"format\":\"parquet\",\n \"hook\":\"xyz.test.com\"\n}"},"url":"https://unification.useinsider.com/api/raw/v1/export","description":"Export Raw User Data API prepares the raw data for events and attributes together, and also allows you to export App Survey results for multiple requested events and attributes of a user (e.g. name, phone number, age, city, etc.) into Insider's AWS S3 bucket. The request returns a link to partner's webhook endpoint, and this link enables you to have access to the raw user data and transfer it to your end.
\nWhen a user sees an app template, this action triggers the survey_result event respectively along with its timestamp, answer, camp ID, question, and variant ID event parameters. These events and their parameters can be listed on the respective user's User Profile.
\n\nSuggested Reading: Understanding Events and Attributes
\n
You should provide a webhook endpoint in the request to be notified when the export link is ready. After sending a request, your webhook endpoint receives an export link as follows to have access to the raw user data.
\nhttps://insider-data-export.useinsider.com/{partner name}/p/{file name}
You can export raw user data in the following use cases:
\nBefore starting the implementation, make sure to share the following information with your Insider Technical Account Manager:
\nYou can consult your Insider Technical Account Manager on which parameters to add in the request.
\nThe sample below displays a request to get the app template results along with raw user data (e.g. insider ID (iid), unique device ID (udid), phone number (pn), unique user ID (uuid), email (em), app version, model (mo), device software version (ov)).
\n{\n \"segment\": {\n \"segment_id\": 123456789\n },\n \"attributes\":[\n \"iid\",\n \"udid\",\n \"pn\",\n \"uuid\",\n \"em\",\n \"app_version\",\n \"mo\",\n \"ov\"\n ],\n \"events\":{\n \"start_date\":1606311893,\n \"end_date\":1611582293,\n \"wanted\":[\n {\n \"event_name\":\"survey_result\",\n \"params\":[\n \"timestamp\",\n \"answer\",\n \"camp_id\",\n \"question\",\n \"variant_id\"\n ]\n }\n ]\n },\n \"format\":\"parquet\",\n \"hook\":\"xyz.test.com\"\n}\n\nWhen the data is ready to download, you will receive the export link on your webhook URL as displayed below.
\n{\"url\":\"https://insider-data-export.useinsider.com/{partner name}/p/{file name}\"}\n\n\n\nIf a user has performed the requested event(s) N times, that user will be displayed in N rows in the exported file. However, since attributes always display the latest information of the user, the attributes on N rows will be the same.
\n
If you exceed the rate limits, you receive an error shown below.
\n{\n \"error\": \"rejected: too many requests\"\n}\n\nDepending on your request, you might also receive 400 Empty Partner, 400 Empty Token, or 403 Authentication Failed responses.
\nMobile App Reporting APIs help you get your app push analytics, export your app push and inApp engagement reports, and export your survey results.
\n","_postman_id":"a7ec4d15-85ed-42f8-ae30-95e8e8f656a1"},{"name":"OnSite","item":[{"name":"Get onsite campaign analytics","id":"62883d70-3fa1-46bf-97c6-ebd43614792e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Go to InOne Settings > Integration Settings > API Keys to generate your token.
\n","type":"text"}],"url":"http://analytics.api.useinsider.com/onsite/v1/campaign","description":"This API enables you to change the filter values on OnSite campaign analytics from your own back-end without using Insider’s platform.
\nYou need to send the filters in body parameters.
\nAdding filters is only valid for all campaign stats.
\nIf you add filters parameter to body and there is no value, the request is sent with default values of the filters that you can see below:
\n\"filters\": [\n{\n\"field\": \"impression\",\n\"operator\": \"gte\",\n\"value\": 200\n},\n{\n\"field\": \"significance\",\n\"operator\": \"gte\",\n\"value\": 0\n}\n]\n\nBefore sending the request, make sure to replace the authorization value with your own OnSite Campaign Analytics API key.
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"details\": [\n {\n \"activeDays\": 239,\n \"averageOrderValue\": 260.53068340306834,\n \"averageOrderValueUplift\": 0.2435810228696742,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 8,\n \"campaignName\": \"My campaign\",\n \"clickConversion\": 19598,\n \"clickThroughRate\": 0.19069767441860466,\n \"conversionRateUplift\": 0.4216142270861831,\n \"goalId\": 0,\n \"impression\": 102770,\n \"incrementalConversion\": 1701.150115473441,\n \"incrementalRevenue\": 649101.4595842956,\n \"revenue\": 1494404,\n \"revenueFromClick\": 373601,\n \"salesConversion\": 5736,\n \"salesConversionRate\": 0.05581395348837209,\n \"salesFromClick\": 1434,\n \"selectedGoalConversion\": 5736,\n \"selectedGoalConversionRate\": 0.05581395348837209,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999199999999999\n },\n {\n \"activeDays\": 239,\n \"averageOrderValue\": 227.98419339841934,\n \"averageOrderValueUplift\": 0.24369133790924957,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 20,\n \"campaignName\": \"My amazing campaign\",\n \"clickConversion\": 26768,\n \"clickThroughRate\": 0.2196078431372549,\n \"conversionRateUplift\": 0.39276018099547527,\n \"goalId\": 0,\n \"impression\": 121890,\n \"incrementalConversion\": 1213.1695906432751,\n \"incrementalRevenue\": 414566.7134502925,\n \"revenue\": 980788,\n \"revenueFromClick\": 217953,\n \"salesConversion\": 4302,\n \"salesConversionRate\": 0.03529411764705882,\n \"salesFromClick\": 956,\n \"selectedGoalConversion\": 4302,\n \"selectedGoalConversionRate\": 0.03529411764705882,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999199999999999\n }\n ],\n \"goalIdList\": [\n 1001362,\n 1001365,\n 1001368\n ]\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we received an invalid request. The start date cannot be after the end date.
\nSorry, we received an invalid request. We are able to provide the analytics data for only the last 1 year.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations.
\nRequired. Specifies a 10-digit epoch start time
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"disabled":true,"description":{"content":"Specifies a 10-digit epoch end time
\n","type":"text/plain"},"key":"endTime","value":"int64"},{"disabled":true,"description":{"content":"Required. Your campaign builder ID
\n","type":"text/plain"},"key":"campaignBuilderId","value":"integer"}],"variable":[]}},"response":[{"id":"0958084a-b9c4-41d7-99c5-3bab6638d0cd","name":"Get analytics with campaign builder ID","originalRequest":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Go to InOne Settings > Integration Settings > API Keys to generate your token.","type":"text"}],"url":{"raw":"http://analytics.api.useinsider.com/onsite/v1/campaign?startTime=1672592719&endTime=1683738339&campaignBuilderId=68","protocol":"http","host":["analytics","api","useinsider","com"],"path":["onsite","v1","campaign"],"query":[{"key":"startTime","value":"1672592719","description":"Specifies a 10-digit epoch start time"},{"key":"endTime","value":"1683738339","description":"Specifies a 10-digit epoch end time"},{"key":"campaignBuilderId","value":"68","description":"Your campaign builder ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 May 2023 17:11:38 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7c53cd6f9c1c38f9-IAD","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"detail\": {\n \"click\": {\n \"98\": [\n {\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0,\n \"campaignId\": 98,\n \"campaignName\": \"My campaign\",\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"conversionRateUplift\": 0,\n \"goal\": \"click\",\n \"goalConversion\": 0,\n \"goalConversionRate\": 0,\n \"impression\": 2325,\n \"incrementalConversion\": 0,\n \"incrementalRevenue\": 0,\n \"leadCount\": 0,\n \"platform\": \"all\",\n \"revenue\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"significance\": 0\n }\n ],\n \"99\": [\n {\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.9999,\n \"campaignId\": 99,\n \"campaignName\": \"My amazing campaign\",\n \"conversion\": 364,\n \"conversionRate\": 0.023144910027341516,\n \"conversionRateUplift\": 0,\n \"goal\": \"click\",\n \"goalConversion\": 364,\n \"goalConversionRate\": 0.023144910027341516,\n \"impression\": 15727,\n \"incrementalConversion\": 364,\n \"incrementalRevenue\": 0,\n \"leadCount\": 0,\n \"platform\": \"all\",\n \"revenue\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"significance\": 0.9999\n }\n ]\n },\n \"sales\": {\n \"98\": [\n {\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.8702,\n \"campaignId\": 98,\n \"campaignName\": \"My campaign\",\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"conversionRateUplift\": 0,\n \"goal\": \"sales\",\n \"goalConversion\": 0,\n \"goalConversionRate\": 0,\n \"impression\": 2325,\n \"incrementalConversion\": 0,\n \"incrementalRevenue\": 0,\n \"leadCount\": 0,\n \"platform\": \"all\",\n \"revenue\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"significance\": 0\n }\n ],\n \"99\": [\n {\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.1297,\n \"campaignId\": 99,\n \"campaignName\": \"My amazing campaign\",\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"conversionRateUplift\": 0,\n \"goal\": \"sales\",\n \"goalConversion\": 0,\n \"goalConversionRate\": 0,\n \"impression\": 15727,\n \"incrementalConversion\": 0,\n \"incrementalRevenue\": 0,\n \"leadCount\": 0,\n \"platform\": \"all\",\n \"revenue\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"significance\": 0\n }\n ]\n },\n \"salesFromClick\": {\n \"98\": [\n {\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.8702,\n \"campaignId\": 98,\n \"campaignName\": \"My campaign\",\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"conversionRateUplift\": 0,\n \"goal\": \"salesFromClick\",\n \"goalConversion\": 0,\n \"goalConversionRate\": 0,\n \"impression\": 2325,\n \"incrementalConversion\": 0,\n \"incrementalRevenue\": 0,\n \"leadCount\": 0,\n \"platform\": \"all\",\n \"revenue\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"significance\": 0\n }\n ],\n \"99\": [\n {\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.1297,\n \"campaignId\": 99,\n \"campaignName\": \"My amazing campaign\",\n \"conversion\": 0,\n \"conversionRate\": 0,\n \"conversionRateUplift\": 0,\n \"goal\": \"salesFromClick\",\n \"goalConversion\": 0,\n \"goalConversionRate\": 0,\n \"impression\": 15727,\n \"incrementalConversion\": 0,\n \"incrementalRevenue\": 0,\n \"leadCount\": 0,\n \"platform\": \"all\",\n \"revenue\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"significance\": 0\n }\n ]\n }\n },\n \"summary\": {\n \"98\": 64,\n \"99\": 87\n }\n }\n}"}],"_postman_id":"62883d70-3fa1-46bf-97c6-ebd43614792e"},{"name":"Get onsite overall analytics","id":"a1ee4686-a07a-4317-9e1c-90a611f9016c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Go to InOne Settings > Integration Settings > API Keys to generate your token.
\n","type":"text"}],"url":"http://analytics.api.useinsider.com/onsite/v1/all","description":"This API enables you to change the filter values on OnSite campaign analytics from your own back-end without using Insider’s platform.
\nYou need to send the filters in body parameters.
\nAdding filters is only valid for all campaign stats.
\nIf you add filters parameter to body and there is no value, the request is sent with default values of the filters that you can see below:
\n\"filters\": [\n{\n\"field\": \"impression\",\n\"operator\": \"gte\",\n\"value\": 200\n},\n{\n\"field\": \"significance\",\n\"operator\": \"gte\",\n\"value\": 0\n}\n]\n\nBefore sending the request, make sure to replace the authorization value with your own OnSite Campaign Analytics API key.
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"details\": [\n {\n \"activeDays\": 239,\n \"averageOrderValue\": 260.53068340306834,\n \"averageOrderValueUplift\": 0.2435810228696742,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 8,\n \"campaignName\": \"My campaign\",\n \"clickConversion\": 19598,\n \"clickThroughRate\": 0.19069767441860466,\n \"conversionRateUplift\": 0.4216142270861831,\n \"goalId\": 0,\n \"impression\": 102770,\n \"incrementalConversion\": 1701.150115473441,\n \"incrementalRevenue\": 649101.4595842956,\n \"revenue\": 1494404,\n \"revenueFromClick\": 373601,\n \"salesConversion\": 5736,\n \"salesConversionRate\": 0.05581395348837209,\n \"salesFromClick\": 1434,\n \"selectedGoalConversion\": 5736,\n \"selectedGoalConversionRate\": 0.05581395348837209,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999199999999999\n },\n {\n \"activeDays\": 239,\n \"averageOrderValue\": 227.98419339841934,\n \"averageOrderValueUplift\": 0.24369133790924957,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 20,\n \"campaignName\":\"My amazing campaign\",\n \"clickConversion\": 26768,\n \"clickThroughRate\": 0.2196078431372549,\n \"conversionRateUplift\": 0.39276018099547527,\n \"goalId\": 0,\n \"impression\": 121890,\n \"incrementalConversion\": 1213.1695906432751,\n \"incrementalRevenue\": 414566.7134502925,\n \"revenue\": 980788,\n \"revenueFromClick\": 217953,\n \"salesConversion\": 4302,\n \"salesConversionRate\": 0.03529411764705882,\n \"salesFromClick\": 956,\n \"selectedGoalConversion\": 4302,\n \"selectedGoalConversionRate\": 0.03529411764705882,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999199999999999\n }\n ],\n \"goalIdList\": [\n 1001362,\n 1001365,\n 1001368\n ]\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we received an invalid request. The start date cannot be after the end date.
\nSorry, we received an invalid request. We are able to provide the analytics data for only the last 1 year.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations.
\nRequired. Specifies a 10-digit epoch start time
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"disabled":true,"description":{"content":"Specifies a 10-digit epoch end time
\n","type":"text/plain"},"key":"endTime","value":"int64"},{"disabled":true,"description":{"content":"Required. Your campaign report time. Its values can be \"ab\", \"hundred\".
\n","type":"text/plain"},"key":"campaignReportType","value":"string"},{"disabled":true,"description":{"content":"Required. Your goal type of the data. Its values can be \"sales\", \"click\", \"salesFromClick\".
\n","type":"text/plain"},"key":"selectedGoalType","value":"string"},{"disabled":true,"description":{"content":"Required. Your report type for the data to be fetched. Its values can be \"detail\", \"summary\".
\n","type":"text/plain"},"key":"reportType","value":"string"}],"variable":[]}},"response":[{"id":"2ddf1b0c-81a3-4647-be29-4e98b8670aeb","name":"Get click goal for ab campaigns","originalRequest":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"","description":"This key is required to authorize your request. Go to InOne Settings > Integration Settings > API Keys to generate your token.","type":"text"}],"url":{"raw":"http://analytics.api.useinsider.com/onsite/v1/all?startTime=1672592719&endTime=1683738339&campaignReportType=ab&selectedGoalType=click&reportType=detail","protocol":"http","host":["analytics","api","useinsider","com"],"path":["onsite","v1","all"],"query":[{"key":"startTime","value":"1672592719","description":"Specifies a 10-digit epoch start time"},{"key":"endTime","value":"1683738339","description":"Specifies a 10-digit epoch end time"},{"key":"campaignReportType","value":"ab","description":"Your campaign report time. Its values can be \"ab\", \"hundred\"."},{"key":"selectedGoalType","value":"click","description":"Your goal type of the data. Its values can be \"sales\", \"click\", \"salesFromClick\"."},{"key":"reportType","value":"detail","description":"Your report type for the data to be fetched. Its values can be \"detail\", \"summary\"."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 May 2023 17:09:22 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"7c53ca19de3081df-IAD","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"details\": [\n {\n \"activeDays\": 87,\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 99,\n \"campaignName\": \"My campaign\",\n \"clickConversion\": 364,\n \"clickThroughRate\": 0.023144910027341516,\n \"conversionRateUplift\": 0,\n \"goalId\": 0,\n \"impression\": 15727,\n \"incrementalConversion\": 364,\n \"incrementalRevenue\": 0,\n \"revenue\": 0,\n \"revenueFromClick\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"salesFromClick\": 0,\n \"selectedGoalConversion\": 364,\n \"selectedGoalConversionRate\": 0.023144910027341516,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999\n },\n {\n \"activeDays\": 19,\n \"averageOrderValue\": 0,\n \"averageOrderValueUplift\": 0,\n \"bayesianSignificance\": 0.2214,\n \"builderType\": \"custom\",\n \"campaignId\": 101,\n \"campaignName\": \"My amazing campaign\",\n \"clickConversion\": 3,\n \"clickThroughRate\": 0.0032258064516129032,\n \"conversionRateUplift\": 0,\n \"goalId\": 0,\n \"impression\": 930,\n \"incrementalConversion\": 3,\n \"incrementalRevenue\": 0,\n \"revenue\": 0,\n \"revenueFromClick\": 0,\n \"salesConversion\": 0,\n \"salesConversionRate\": 0,\n \"salesFromClick\": 0,\n \"selectedGoalConversion\": 3,\n \"selectedGoalConversionRate\": 0.0032258064516129032,\n \"selectedGoalId\": 0,\n \"significance\": 0.3328\n }\n ],\n \"goalIdList\": [\n 39,\n 40,\n 32,\n 41,\n 38\n ]\n }\n}"}],"_postman_id":"a1ee4686-a07a-4317-9e1c-90a611f9016c"},{"name":"Change filter values","id":"8c1e75b8-8d48-4159-a138-6b3d9ac60559","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"","type":"text"}],"url":"analytics.api.useinsider.com/onsite/v2/all","description":"This API enables you to change the filter values on OnSite campaign analytics from your own back-end without using Insider’s platform.
\nYou need to send the filters in body parameters.
\nAdding filters is only valid for all campaign stats.
\nIf you add filters parameter to body and there is no value, the request is sent with default values of the filters that you can see below:
\n{\n \"startTime\": 1646611200,\n \"endTime\": 1667222349,\n \"campaignReportType\": \"ab\",\n \"selectedGoalType\": \"sales\",\n \"reportType\": \"detail\",\n \"filters\": [\n {\n \"field\": \"impression\",\n \"operator\": \"gte\",\n \"value\": 90000\n },\n {\n \"field\": \"significance\",\n \"operator\": \"gte\",\n \"value\": 0.9\n }\n ]\n}\n\nBefore sending the request, make sure to replace the authorization value with your own OnSite Campaign Analytics API key.
\nThe following response returns if the request is successful.
\n{\n \"data\": {\n \"details\": [\n {\n \"activeDays\": 239,\n \"averageOrderValue\": 260.53068340306834,\n \"averageOrderValueUplift\": 0.2435810228696742,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 8,\n \"campaignName\": \"My campaign\",\n \"clickConversion\": 19598,\n \"clickThroughRate\": 0.19069767441860466,\n \"conversionRateUplift\": 0.4216142270861831,\n \"goalId\": 0,\n \"impression\": 102770,\n \"incrementalConversion\": 1701.150115473441,\n \"incrementalRevenue\": 649101.4595842956,\n \"revenue\": 1494404,\n \"revenueFromClick\": 373601,\n \"salesConversion\": 5736,\n \"salesConversionRate\": 0.05581395348837209,\n \"salesFromClick\": 1434,\n \"selectedGoalConversion\": 5736,\n \"selectedGoalConversionRate\": 0.05581395348837209,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999199999999999\n },\n {\n \"activeDays\": 239,\n \"averageOrderValue\": 227.98419339841934,\n \"averageOrderValueUplift\": 0.24369133790924957,\n \"bayesianSignificance\": 0.9999,\n \"builderType\": \"custom\",\n \"campaignId\": 20,\n \"campaignName\": \"My amazing campaign\",\n \"clickConversion\": 26768,\n \"clickThroughRate\": 0.2196078431372549,\n \"conversionRateUplift\": 0.39276018099547527,\n \"goalId\": 0,\n \"impression\": 121890,\n \"incrementalConversion\": 1213.1695906432751,\n \"incrementalRevenue\": 414566.7134502925,\n \"revenue\": 980788,\n \"revenueFromClick\": 217953,\n \"salesConversion\": 4302,\n \"salesConversionRate\": 0.03529411764705882,\n \"salesFromClick\": 956,\n \"selectedGoalConversion\": 4302,\n \"selectedGoalConversionRate\": 0.03529411764705882,\n \"selectedGoalId\": 0,\n \"significance\": 0.9999199999999999\n }\n ],\n \"goalIdList\": [\n 1001362,\n 1000090,\n 1001132,\n 1000781,\n 1001436,\n 1000768,\n 1000030,\n 1001092,\n 1000718,\n 1000594,\n 1000765,\n 1000988,\n 1000744,\n 1000742,\n 1000854,\n 1001399,\n 1000881,\n 1001088,\n 1001390,\n 1000731,\n 1001200,\n 1001121,\n 1000795,\n 1000239,\n 1000699,\n 1001389,\n 1000709,\n 1001439,\n 1001133,\n 1000852,\n 1001151,\n 1001449,\n 1001090,\n 1001120,\n 1001017,\n 1001152,\n 1001205,\n 1000948,\n 1000858,\n 1001074,\n 1000712,\n 1000774,\n 1000720,\n 1001049,\n 1000801,\n 1000786,\n 1001184,\n 1001319,\n 1000707,\n 1000743,\n 1001169,\n 1000949,\n 1000798,\n 1001019,\n 1000991,\n 1001025,\n 1000968,\n 1001323,\n 1000831,\n 1000368,\n 1000688,\n 1000713,\n 1001354,\n 1001102,\n 1000853,\n 1001172,\n 1000685,\n 1001096,\n 1000708,\n 1000797,\n 1000824,\n 1001318,\n 1001060,\n 1000916,\n 1001353,\n 1001081,\n 1001136,\n 1001016,\n 1001104,\n 1000261,\n 1000704,\n 1000755,\n 1000884,\n 1000754,\n 1000751,\n 1001029,\n 1000933,\n 1001251,\n 1000741,\n 1000244,\n 1000819,\n 1000726,\n 1001208,\n 1001440,\n 1001199,\n 1001003,\n 1001083,\n 1001437,\n 1000730,\n 1000827,\n 1000830,\n 1001113,\n 1001028,\n 1000715,\n 1000951,\n 1001014,\n 1000800,\n 1000823,\n 1001293,\n 1000820,\n 1000862,\n 1000767,\n 1001030,\n 1000193,\n 1000947,\n 1001298\n ]\n }\n}\n\nSorry, we’ve received an invalid request from your side. You can try again later.
\nSorry, we received an invalid request. The start date cannot be after the end date.
\nSorry, we received an invalid request. We are able to provide the analytics data for only the last 1 year.
\nSorry, we couldn’t receive any response from our server. You can try again later.
\nWhen sending your request, make sure to follow these limitations.
\nRequired. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"disabled":true,"description":{"content":"Specifies a 10-digit epoch end time.
\n","type":"text/plain"},"key":"endTime","value":"int64"},{"disabled":true,"description":{"content":"Required. The campaign report type to be used.
\n","type":"text/plain"},"key":"campaignReportType","value":"string"},{"disabled":true,"description":{"content":"Required. The goal type of the data.
\n","type":"text/plain"},"key":"selectedGoalType","value":"string"},{"disabled":true,"description":{"content":"Required. The report type for data to be fetched
\n","type":"text/plain"},"key":"reportType","value":"string"},{"disabled":true,"description":{"content":"Required. Used for filtering campaigns
\n","type":"text/plain"},"key":"filters","value":"string"},{"disabled":true,"description":{"content":"Required. Metrics used in analytics
\n","type":"text/plain"},"key":"field","value":"string"},{"disabled":true,"description":{"content":"Required. Used for searching for values in a given field.
\n","type":"text/plain"},"key":"operator","value":"string"},{"disabled":true,"description":{"content":"The value of the field.
\n","type":"text/plain"},"key":"value","value":"float"}],"variable":[]}},"response":[],"_postman_id":"8c1e75b8-8d48-4159-a138-6b3d9ac60559"}],"id":"6665beca-4a5b-441e-afc7-6cfd310d9483","description":"This API enables you to get onsite campaign of your on-site campaigns from your own back-end without using Insider’s platform.
\n","_postman_id":"6665beca-4a5b-441e-afc7-6cfd310d9483"},{"name":"SMS","item":[{"name":"Get SMS campaign list","id":"c2f8e5da-59e9-4a42-a771-0cc59b785d83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-INS-AUTH-KEY","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.\nInsider's SMS Analytics API allows you to get the SMS campaigns list from your back-end without using the Insider's InOne panel. This API returns Active, Test, Passive, Completed, and Stopped campaigns with this endpoint.
\nPlease note that the endTime field operates on a T-1 logic:
- To define a time range, ensure that the endTime is set to one second before the upper limit of the range.
- For example, for a time range of 11-11-2024 10:00:00 to 11-11-2024 11:00:00, set the end_date to 11-11-2024 10:59:59The minimum allowed time range for requests is 1 hour. If the requested interval is shorter, the system aggregates and returns data for the entire hour. For instance, a 30-minute request will still yield data for the full hour.
Before sending the request, make sure to replace the authorization value with your own API key.
\ncurl --location 'https://sms.useinsider.com/analytics/v1/list?perPage=10&page=1' \\\n--header 'x-ins-auth-key:1a2b3c4d5e6f \\'\n\nCampaigns are listed in order from newest to oldest.
\n{\n \"current_page\":1,\n \"data\":[\n {\n \"campaignId\":12692,\n \"campaignName\":\"Sample Campaign 3\",\n \"startTime\":1727770020,\n \"status\":\"completed\"\n },\n {\n \"campaignId\":12691,\n \"campaignName\":\"Sample Campaign 2\",\n \"startTime\":1727770260,\n \"status\":\"completed\"\n },\n {\n \"campaignId\":12689,\n \"campaignName\":\"Sample Campaign 1\",\n \"startTime\":1727770356,\n \"status\":\"completed\"\n },\n ],\n \"first_page_url\":\"https://sms.useinsider.com/analytics/v1/list?perPage=10&page=1\",\n \"from\":1,\n \"last_page\":160,\n \"last_page_url\":\"https://sms.useinsider.com/analytics/v1/list?perPage=10&page=160\",\n \"next_page_url\":\"https://sms.useinsider.com/analytics/v1/list?perPage=10&page=2\",\n \"per_page\":10,\n \"prev_page_url\":null,\n \"to\":10,\n \"totalCampaign\":1596 }\n\n401: Unauthorized request. Please make sure of your authorization key correctness
\n422: Your data is not valid.
\nAll functions must be executed with an HTTPS POST request.
\nThe X-INS-AUTH-KEY should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1-year range.
\nYou can send 100 requests per minute with the same API Key. If you exceed the rate limit, the perPage value should be between 1-100.
\nSpecifies the number of pages of SMS campaigns
\n","type":"text/plain"},"key":"Page","value":"Integer"},{"description":{"content":"Specifies the number of pages of SMS campaigns
\n","type":"text/plain"},"key":"PerPage","value":"Integer"}],"variable":[]}},"response":[],"_postman_id":"c2f8e5da-59e9-4a42-a771-0cc59b785d83"},{"name":"Get SMS campaign analytics","id":"4f3a83e0-d4aa-4fe2-8f4d-c446b6c7c902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 11242\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.useinsider.com/analytics/v1/campaign?campaignId=Integer","description":"SMS Campaign Analytics details will be listed as you send a request to this API.
\nThis API does not contain Architect Analytics.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your API key.
\nTo replace the sample values in campaignID with your value in the required data type.
\ncurl --location 'https://sms.useinsider.com/analytics/v1/campaign' \\\n--header 'x-ins-auth-key: 1a2b3c4d5e6f' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"campaignId\": 11242\n}'\n\n{\n \"targeted\":0,\n \"messageParts\":0,\n \"sent\":0,\n \"dropped\":0,\n \"delivery\":{\n \"count\":{\n \"delivered\":0,\n \"undelivered\":0\n },\n \"rate\":\"0.00%\"\n },\n \"clickThrough\":{\n \"clicks\":0,\n \"rate\":\"0.00%\",\n \"revenue\":\"0\"\n },\n \"conversion\":{\n \"conversions\":0,\n \"rate\":\"0.00%\"\n },\n \"unsubscribers\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"droppedMessages\":{\n \"frequencyCapped\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"duplicates\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"internalErrors\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"countryCodeDrops\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"invalidPhoneNumbers\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"couponListDrops\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n },\n \"silentHours\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n }\n },\n \"undeliveredMessages\":{\n \"carrierViolations\":{\n \"count\":0,\n \"rate\":\"0.00%\",\n \"details\":[\n ]\n },\n \"hardBounces\":{\n \"count\":0,\n \"rate\":\"0.00%\",\n \"details\":[\n ]\n },\n \"softBounces\":{\n \"count\":0,\n \"rate\":\"0.00%\",\n \"details\":[\n ]\n },\n \"deliveryFailures\":{\n \"count\":0,\n \"rate\":\"0.00%\",\n \"details\":[\n ]\n },\n \"deliveryReportMissing\":{\n \"count\":0,\n \"rate\":\"0.00%\"\n }\n }\n}\n\n401: Unauthorized request. Please make sure of your authorization key correctness
\n422: This campaign ID is not valid. Please be sure that your campaign ID belongs to your account.
\nAll functions must be executed with an HTTPS POST request.
\nThe X-INS-AUTH-KEY should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1-year range.
\nYou can send 100 requests per minute with the same API Key. If you exceed the rate limit, the perPage value should be between 1-100.
\nYour campaign ID that can be found on the campaign URL
\n","type":"text/plain"},"key":"campaignId","value":"Integer"}],"variable":[]}},"response":[],"_postman_id":"4f3a83e0-d4aa-4fe2-8f4d-c446b6c7c902"},{"name":"Get overall SMS campaign analytics","id":"4b35d7e3-f41d-4e5a-8232-0321c3e47c43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"startTime\": 1727643600,\n \"endTime\": 1728334799\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.useinsider.com/analytics/v1/overall?startTime=int64&endTime=int64","description":"SMS Overall Campaign Analytics details will be listed for a given period as you send a request to this API.
\nThis API does not contain Architect Analytics.
\nPlease note that the endTime field operates on a T-1 logic:
- To define a time range, ensure that the endTime is set to one second before the upper limit of the range.
- For example, for a time range of 11-11-2024 10:00:00 to 11-11-2024 11:00:00, set the end_date to 11-11-2024 10:59:59The minimum allowed time range for requests is 1 hour. If the requested interval is shorter, the system aggregates and returns data for the entire hour. For instance, a 30-minute request will still yield data for the full hour.
Before sending the request, make sure:
\nTo replace the authorization value with your API key.
\nTo replace the sample values in startTime, and endTime with your values in the required data type.
\ncurl --location 'https://sms.useinsider.com/analytics/v1/overall' \\\n--header 'x-ins-auth-key: 1a2b3c4d5e6f' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"startTime\": 1727643600,\n \"endTime\": 1728334799\n}'\n\n{\n \"summary\": {\n \"targeted\": 19723,\n \"messageParts\": 39446,\n \"sent\": 19723,\n \"dropped\": 0,\n \"delivery\": {\n \"count\": {\n \"delivered\": 19031,\n \"undelivered\": 692\n },\n \"rate\": \"96.49%\"\n },\n \"clickThrough\": {\n \"clicks\": 214,\n \"rate\": \"1.12%\",\n \"revenue\": \"151\"\n },\n \"conversion\": {\n \"conversions\": 1,\n \"rate\": \"0.01%\"\n },\n \"unsubscribers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"droppedMessages\": {\n \"frequencyCapped\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"duplicates\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"internalErrors\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"countryCodeDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"invalidPhoneNumbers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"couponListDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"silentHours\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n },\n \"undeliveredMessages\": {\n \"carrierViolations\": {\n \"count\": 70,\n \"rate\": \"10.12%\",\n \"details\": {\n \"3032\": 69,\n \"3034\": 1\n }\n },\n \"hardBounces\": {\n \"count\": 11,\n \"rate\": \"1.59%\",\n \"details\": {\n \"3216\": 2,\n \"3221\": 9\n }\n },\n \"softBounces\": {\n \"count\": 186,\n \"rate\": \"26.88%\",\n \"details\": {\n \"3300\": 186\n }\n },\n \"deliveryFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryReportMissing\": {\n \"count\": 425,\n \"rate\": \"61.42%\"\n }\n }\n },\n \"detail\": [\n {\n \"campaignId\":1234,\n \"campaignName\": \"Sample Campaign 1\",\n \"status\": \"completed\",\n \"startTime\": 1728381600,\n \"endTime\": 1728382560,\n \"targeted\": 19723,\n \"messageParts\": 39446,\n \"sent\": 19723,\n \"dropped\": 0,\n \"delivery\": {\n \"count\": {\n \"delivered\": 19031,\n \"undelivered\": 692\n },\n \"rate\": \"96.49%\"\n },\n \"clickThrough\": {\n \"clicks\": 214,\n \"rate\": \"1.12%\",\n \"revenue\": \"151\"\n },\n \"conversion\": {\n \"conversions\": 1,\n \"rate\": \"0.01%\"\n },\n \"unsubscribers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"droppedMessages\": {\n \"frequencyCapped\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"duplicates\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"internalErrors\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"countryCodeDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"invalidPhoneNumbers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"couponListDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"silentHours\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n },\n \"undeliveredMessages\": {\n \"carrierViolations\": {\n \"count\": 70,\n \"rate\": \"10.12%\",\n \"details\": {\n \"3032\": 69,\n \"3034\": 1\n }\n },\n \"hardBounces\": {\n \"count\": 11,\n \"rate\": \"1.59%\",\n \"details\": {\n \"3216\": 2,\n \"3221\": 9\n }\n },\n \"softBounces\": {\n \"count\": 186,\n \"rate\": \"26.88%\",\n \"details\": {\n \"3300\": 186\n }\n },\n \"deliveryFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryReportMissing\": {\n \"count\": 425,\n \"rate\": \"61.42%\"\n }\n }\n },\n {\n \"campaignId\": 12345,\n \"campaignName\": \"Sample Campaign 2\",\n \"status\": \"passive\",\n \"startTime\": 1690281000,\n \"endTime\": 2050214340,\n \"targeted\": 0,\n \"messageParts\": 0,\n \"sent\": 0,\n \"dropped\": 0,\n \"delivery\": {\n \"count\": {\n \"delivered\": 0,\n \"undelivered\": 0\n },\n \"rate\": \"0.00%\"\n },\n \"clickThrough\": {\n \"clicks\": 0,\n \"rate\": \"0.00%\",\n \"revenue\": \"0\"\n },\n \"conversion\": {\n \"conversions\": 0,\n \"rate\": \"0.00%\"\n },\n \"unsubscribers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"droppedMessages\": {\n \"frequencyCapped\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"duplicates\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"internalErrors\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"countryCodeDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"invalidPhoneNumbers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"couponListDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"silentHours\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n },\n \"undeliveredMessages\": {\n \"carrierViolations\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"hardBounces\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"softBounces\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryReportMissing\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n }\n }\n ]\n}\n\n401: Unauthorized request. Please make sure of your authorization key correctness
\n422
\nThe start time parameter must be earlier than the end time.
\nThe start time parameter must be within the last 1 year.
\nThe end time parameter must be earlier than the current time.
\nThe start time parameter must be a valid integer.
\nThe end time parameter must be a valid integer.
\n429: Your request exceeds the limit.
\nAll functions must be executed with an HTTPS POST request.
\nThe X-INS-AUTH-KEY should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1-year range.
\nYou can send 100 requests per minute with the same API Key. If you exceed the rate limit, the perPage value should be between 1-100.
\nThe time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"description":{"content":"The current date (today’s date on the payload). It can be customizable according to your use case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"int64"}],"variable":[]}},"response":[],"_postman_id":"4b35d7e3-f41d-4e5a-8232-0321c3e47c43"},{"name":"Get Transactional SMS analytics","id":"9497ffff-69c2-4298-96f4-f78f82d08d9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"startTime\": 1727643600,\n \"endTime\": 1728334799\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.useinsider.com/analytics/v1/transactional?startTime=Int64&endTime=Int64","description":"Transactional SMS Analytics details will be listed for a given time period as you send a request to this API.
\nPlease note that the endTime field operates on a T-1 logic:
- To define a time range, ensure that the endTime is set to one second before the upper limit of the range.
- For example, for a time range of 11-11-2024 10:00:00 to 11-11-2024 11:00:00, set the end_date to 11-11-2024 10:59:59The minimum allowed time range for requests is 1 hour. If the requested interval is shorter, the system aggregates and returns data for the entire hour. For instance, a 30-minute request will still yield data for the full hour.
Before sending the request, make sure:
\nTo replace the authorization value with your API key.
\nTo replace the sample values in startTime, and endTime with your values in the required data type.
\ncurl --location 'https://sms.useinsider.com/analytics/v1/transactional' \\\n--header 'x-ins-auth-key: 1a2b3c4d5e6f' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"startTime\": 1727643600,\n \"endTime\": 1728334799\n}'\n\n{\n \"messageParts\": 0,\n \"sent\": 0,\n \"dropped\": 0,\n \"delivery\": {\n \"count\": {\n \"delivered\": 0,\n \"undelivered\": 0\n },\n \"rate\": \"0.00%\"\n },\n \"clickThrough\": {\n \"clicks\": 0,\n \"rate\": \"0.00%\"\n },\n \"droppedMessages\": {\n \"internalErrors\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"countryCodeDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"invalidPhoneNumbers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n },\n \"undeliveredMessages\": {\n \"carrierViolations\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"hardBounces\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"softBounces\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryReportMissing\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n }\n}\n\n401: Unauthorized request. Please make sure of your authorization key correctness
\n422
\nThe start time parameter must be earlier than the end time.
\nThe start time parameter must be within the last 1 year.
\nThe end time parameter must be earlier than the current time.
\nThe start time parameter must be a valid integer.
\nThe end time parameter must be a valid integer.
\n429: Your request exceeds the limit.
\nAll functions must be executed with an HTTPS POST request.
\nThe X-INS-AUTH-KEY should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1-year range.
\nYou can send 100 requests per minute with the same API Key. If you exceed the rate limit, the perPage value should be between 1-100.
\nThe time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"Int64"},{"description":{"content":"The current date (today’s date on the payload). It can be customizable according to your use case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"Int64"}],"variable":[]}},"response":[],"_postman_id":"9497ffff-69c2-4298-96f4-f78f82d08d9c"},{"name":"Get OTP / Verify SMS analytics","id":"bcaa0068-f319-4ec5-898d-5cf28003f152","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-INS-AUTH-KEY","value":"1a2b3c4d5e6f","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"startTime\": 1727643600,\n \"endTime\": 1728334799\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.useinsider.com/analytics/v1/verify","description":"SMS OTP / Verify Analytics details will be listed for a given time period as you send a request to this API.
\nPlease note that the endTime field operates on a T-1 logic:
- To define a time range, ensure that the endTime is set to one second before the upper limit of the range.
- For example, for a time range of 11-11-2024 10:00:00 to 11-11-2024 11:00:00, set the end_date to 11-11-2024 10:59:59The minimum allowed time range for requests is 1 hour. If the requested interval is shorter, the system aggregates and returns data for the entire hour. For instance, a 30-minute request will still yield data for the full hour.
Before sending the request, make sure:
\nTo replace the authorization value with your API key.
\nTo replace the sample values in startTime, and endTime with your values in the required data type.
\ncurl --location 'https://sms.useinsider.com/analytics/v1/verify' \\\n--header 'x-ins-auth-key: 1a2b3c4d5e6f' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"startTime\": 1727643600,\n \"endTime\": 1728334799\n}'\n\n{\n \"messageParts\": 0,\n \"sent\": 0,\n \"dropped\": 0,\n \"delivery\": {\n \"count\": {\n \"delivered\": 0,\n \"undelivered\": 0\n },\n \"rate\": \"0.00%\"\n },\n \"verification\": {\n \"count\": {\n \"verified\": 0,\n \"unverified\": 0\n },\n \"rate\": \"0.00%\"\n },\n \"droppedMessages\": {\n \"internalErrors\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"countryCodeDrops\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"invalidPhoneNumbers\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n },\n \"undeliveredMessages\": {\n \"carrierViolations\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"hardBounces\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"softBounces\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\",\n \"details\": {}\n },\n \"deliveryReportMissing\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n },\n \"unverifiedMessages\": {\n \"attemptFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n },\n \"timeoutFailures\": {\n \"count\": 0,\n \"rate\": \"0.00%\"\n }\n }\n}\n\n401: Unauthorized request. Please make sure of your authorization key correctness
\n422
\nThe start time parameter must be earlier than the end time.
\nThe start time parameter must be within the last 1 year.
\nThe end time parameter must be earlier than the current time.
\nThe start time parameter must be a valid integer.
\nThe end time parameter must be a valid integer.
\n429: Your request exceeds the limit.
\nAll functions must be executed with an HTTPS POST request.
\nThe X-INS-AUTH-KEY should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nThis API provides data for a 1-year range.
\nYou can send 100 requests per minute with the same API Key. If you exceed the rate limit, the perPage value should be between 1-100.
\nRequired. The time campaign is being launched. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"startTime","value":"int64"},{"disabled":true,"description":{"content":"Required. The current date (today’s date on the payload). It can be customizable according to your use case. Specifies a 10-digit epoch start time.
\n","type":"text/plain"},"key":"endTime","value":"int64"}],"variable":[]}},"response":[],"_postman_id":"bcaa0068-f319-4ec5-898d-5cf28003f152"}],"id":"93a1d9f0-aa52-4110-9c2e-01517c49516f","_postman_id":"93a1d9f0-aa52-4110-9c2e-01517c49516f","description":""},{"name":"Architect","item":[{"name":"Get Architect Overall Analytics","id":"c3d12a7f-7169-423f-b69d-b20c6ebb2deb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter the word {{vault:bearer-token}} by the API key you generated.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"You should enter it as application/json at all times.
\n","type":"text"}],"url":"https://architect-analytics.api.useinsider.com/v1/overall?statDate=String","description":"The Architect overall analytics endpoint provides comprehensive analytics data for all user journeys. This data includes key user metrics, journey statuses, and performance insights broken down by channels and journeys, offering a high-level overview of campaign effectiveness and user interactions.
\nThe statDate parameter is essential for defining the time range for analytics. The start date must be earlier than the end date. You can select any time range, including those longer than one year or before the past year. However, if you encounter a timeout when exporting a range longer than one year, try selecting a shorter range.
\nUse statuses, channels, ids, and conversionGoal filters to tailor your analytics queries to specific requirements.
\nFor overall analytics, you can only get the conversion metrics for one goal at a time. You can enter the goal id as a parameter to select which conversion goal you want to see the metrics. You can obtain the Goal ID either from the goal dropdown in the InOne panel or by using the conversion goals information endpoint.
\n![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/image-1732693611876.png\")
\n\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in parameters with your own values in the required data type.
\ncurl -X GET \"https://architect-analytics.api.useinsider.com/v1/overall?statDate=01/08/2024 - 30/08/2024&statuses[]=active&channels[]=email&channels[]=sms\" \\\n-H \"Authorization: {{vault:bearer-token}}\" \\\n-H \"Accept: application/json\"\n\n{\n \"filterDate\": \"01/08/2024 - 30/08/2024\",\n \"attributionType\": \"Click-Through\",\n \"goal\": \"confirmation_page_view\",\n \"partner\": {\n \"exportTime\": \"11/11/2024 11:29\",\n \"accountName\": \"shopbagg\"\n },\n \"statuses\": [],\n \"journeysCount\": {\n \"active\": 1,\n \"passive\": 1,\n \"sunset\": 0,\n \"test\": 0\n },\n \"journeyTags\": [\n \"Survey\",\n \"Tag1\"\n ],\n \"journeyIds\": [\n 89,\n 90\n ],\n \"userMetrics\": {\n \"dropped\": 282138,\n \"exited\": 109647,\n \"completed\": 2391841,\n \"entered\": 2805589,\n \"sent\": 6250485,\n \"delivered\": 6022681,\n \"dropRate\": 10.06,\n \"completeRate\": 85.25,\n \"deliveryRate\": 96.36\n },\n \"exitCriteria\": {\n \"112\": {\n \"type\": \"Event\",\n \"name\": \"email_click\",\n \"parameters\": [],\n \"exited\": 58,\n \"journeys\": [\n {\n \"id\": 89,\n \"name\": \"Journey Name 1\"\n }\n ]\n },\n \"255\": {\n \"type\": \"Event\",\n \"name\": \"payment_successful\",\n \"parameters\": [],\n \"exited\": 14022,\n \"journeys\": [\n {\n \"id\": 90,\n \"name\": \"Journey Name 2\"\n }\n ]\n }\n },\n \"performanceMetrics\": {\n \"totalClicks\": 123137,\n \"totalConversions\": 0,\n \"revenue\": 0,\n \"conversionRate\": 0,\n \"clickThroughRate\": 2.04,\n \"averageOrderValue\": 0\n },\n \"performanceOfChannels\": {\n \"email\": {\n \"conversions\": 0,\n \"drops\": 15120,\n \"delivered\": 3945177,\n \"totalClicks\": 37067,\n \"totalOpens\": 544420,\n \"revenue\": 0,\n \"uniqueClicks\": 13395,\n \"sent\": 3975505,\n \"uniqueOpens\": 452539,\n \"unsubscribes\": 2392,\n \"numberOfChannels\": 697,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 0.34,\n \"dropRate\": 0.38,\n \"conversionRate\": 0,\n \"openRate\": 11.47,\n \"deliveryRate\": 99.24,\n \"unsubscribeRate\": 0.06\n },\n \"app-push\": {\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 0,\n \"totalClicks\": 63,\n \"revenue\": 0,\n \"sent\": 0,\n \"numberOfChannels\": 106,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 0,\n \"dropRate\": 0,\n \"conversionRate\": 0,\n \"deliveryRate\": 0\n },\n \"sms\": {\n \"conversions\": 0,\n \"drops\": 252852,\n \"delivered\": 2041121,\n \"totalClicks\": 53552,\n \"revenue\": 0,\n \"sent\": 2274980,\n \"smsMessageParts\": 3049175,\n \"unsubscribes\": 36745,\n \"numberOfChannels\": 318,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 2.62,\n \"dropRate\": 9.93,\n \"conversionRate\": 0,\n \"deliveryRate\": 89.72,\n \"unsubscribeRate\": 1.8\n },\n \"in-app\": {\n \"conversions\": 0,\n \"drops\": 181,\n \"delivered\": 36383,\n \"totalClicks\": 32455,\n \"revenue\": 0,\n \"sent\": 0,\n \"numberOfChannels\": 15,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 89.2,\n \"dropRate\": 0.06,\n \"conversionRate\": 0,\n \"deliveryRate\": 0\n }\n },\n \"performanceOfJourneys\": {\n \"89\": {\n \"journeyId\": 89,\n \"journeyName\": \"Journey Name 1\",\n \"status\": \"passive\",\n \"averageOrderValue\": 0,\n \"conversions\": 0,\n \"delivered\": 0,\n \"totalClicks\": 11,\n \"totalOpens\": 437,\n \"revenue\": 0,\n \"uniqueClicks\": 11,\n \"sent\": 0,\n \"drops\": 0,\n \"uniqueOpens\": 372,\n \"smsMessageParts\": 0,\n \"unsubscribes\": 1,\n \"clickThroughRate\": 0,\n \"dropRate\": 0,\n \"conversionRate\": 0,\n \"openRate\": 0,\n \"deliveryRate\": 0,\n \"unsubscribeRate\": 0\n },\n \"90\": {\n \"journeyId\": 90,\n \"journeyName\": \"Journey Name 2\",\n \"status\": \"active\",\n \"averageOrderValue\": 0,\n \"conversions\": 0,\n \"delivered\": 0,\n \"totalClicks\": 9,\n \"totalOpens\": 300,\n \"revenue\": 0,\n \"uniqueClicks\": 7,\n \"sent\": 0,\n \"drops\": 0,\n \"uniqueOpens\": 125,\n \"smsMessageParts\": 0,\n \"unsubscribes\": 0,\n \"clickThroughRate\": 0,\n \"dropRate\": 0,\n \"conversionRate\": 0,\n \"openRate\": 0,\n \"deliveryRate\": 0,\n \"unsubscribeRate\": 0\n }\n }\n}\n\n{\n \"error\": \"Invalid API key\"\n}\n\n{\n \"message\": \"The stat date field is required.\",\n \"errors\": {\n \"statDate\": [\n \"The stat date field is required.\"\n ]\n }\n}\n\nid: The unique ID of the conversion goal.
\nname: The name of the conversion goal.
\ntype: The type of conversion goal (e.g., on-event, on-attribute).
\nparameters: An array detailing the conditions for the goal, such as key-value pairs with operators and value types.
\njourneys: A list of journeys where the conversion goal is used, including journey IDs and names.
\nThe request must be executed with an HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nDefines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY
\n","type":"text/plain"},"key":"statDate","value":"String"},{"disabled":true,"description":{"content":"Array filter for journey statuses. Default is active if not provided.\nAllowed values are active, test, passive, sunset.
\n","type":"text/plain"},"key":"statuses","value":"Array of Strings"},{"disabled":true,"description":{"content":"Array filter specifying which channels' analytics data to return. If not provided, all channels are included. Allowed values are web-push, app-push, email, sms, whatsapp, in-app, journey-web, call-api
\n","type":"text/plain"},"key":"channels","value":"Array of Strings"},{"disabled":true,"description":{"content":"Array of journey IDs for filtering
\n","type":"text/plain"},"key":"ids","value":"Array of Integers"},{"disabled":true,"description":{"content":"A number representing the conversion goal ID filter. Default is 0 which is the Purchase goal.
\n","type":"text/plain"},"key":"conversionGoal","value":"Integer"},{"disabled":true,"description":{"content":"Attribution type for reporting. 0 for Click-Through attribution (default). 1 for View-Through attribution.
\n","type":"text/plain"},"key":"goalType","value":"Integer"}],"variable":[]}},"response":[],"_postman_id":"c3d12a7f-7169-423f-b69d-b20c6ebb2deb"},{"name":"Get Architect Journey Analytics","id":"306ea458-652c-41f5-8334-b143f9e08293","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter the word {{vault:bearer-token}} by the API key you generated.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"You should enter it as application/json at all times.
\n","type":"text"}],"url":"https://architect-analytics.api.useinsider.com/v1/journey/{journeyId}?statDate=String","description":"The Architect journey analytics endpoint provides detailed analytics for a specific journey within the Architect product. Use this endpoint to retrieve detailed analytics on a journey to monitor performance, metrics, and channel activities.
\nThe statDate parameter is essential for defining the time range for analytics. The start date must be earlier than the end date. You can select any time range, including those longer than one year or before the past year. However, if you encounter a timeout when exporting a range longer than one year, try selecting a shorter range.
\nUse conversionGoal filter to tailor your analytics queries to specific requirements.
\nFor journey analytics, you can only get the conversion metrics for one goal at a time. You can enter the goal id as a parameter to select which conversion goal you want to see the metrics. You can obtain the Goal ID either from the goal dropdown in the InOne panel or by using the conversion goals information endpoint.
\n![](\"https://cdn.document360.io/c6df4583-da94-4cb2-bb8a-be0cbdd11109/Images/Documentation/image-1732698455540.png\")
\n\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace journeyId with the specific journey's ID.
\ncurl -X GET \"https://architect-analytics.api.useinsider.com/v1/journey/251?statDate=01/08/2024 - 30/08/2024&conversionGoal=123&goalType=0\" \\\n -H \"Authorization: {{vault:bearer-token}}\" \\\n -H \"Accept: application/json\"\n\n{\n \"filterDate\": \"20/05/2024 - 17/10/2024\",\n \"attributionType\": \"Click-Through\",\n \"goal\": \"confirmation_page_view\",\n \"partner\": {\n \"exportTime\": \"11/11/2024 12:13\",\n \"accountName\": \"shopbagg\"\n },\n \"journey\": {\n \"status\": \"active\",\n \"startDate\": \"01/07/2024 16:10\",\n \"endDate\": \"20/12/2034 17:09\",\n \"daysActive\": 133,\n \"journeyId\": 251,\n \"journeyName\": \"Journey Name\",\n \"journeyTags\": [\n \"Lorem ipsum\"\n ]\n },\n \"userMetrics\": {\n \"dropped\": 30167,\n \"exited\": 51412,\n \"completed\": 199181,\n \"entered\": 285966,\n \"sent\": 421412,\n \"delivered\": 414186,\n \"dropRate\": 10.55,\n \"completeRate\": 69.65,\n \"deliveryRate\": 98.29\n },\n \"performanceMetrics\": {\n \"totalClicks\": 15641,\n \"totalConversions\": 0,\n \"revenue\": 0,\n \"conversionRate\": 0,\n \"clickThroughRate\": 3.78,\n \"averageOrderValue\": 0\n },\n \"exitCriteria\": {\n \"386\": {\n \"type\": \"Event\",\n \"name\": \"application_declined\",\n \"parameters\": [],\n \"exited\": 51412\n }\n },\n \"performanceOfChannels\": {\n \"app-push\": {\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 6,\n \"totalClicks\": 0,\n \"revenue\": 0,\n \"sent\": 6,\n \"numberOfChannels\": 2,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 0,\n \"dropRate\": 0,\n \"conversionRate\": 0,\n \"deliveryRate\": 100\n },\n \"email\": {\n \"conversions\": 0,\n \"drops\": 3,\n \"delivered\": 399,\n \"totalClicks\": 177,\n \"totalOpens\": 235,\n \"revenue\": 0,\n \"uniqueClicks\": 31,\n \"sent\": 406,\n \"uniqueOpens\": 151,\n \"unsubscribes\": 3,\n \"numberOfChannels\": 1,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 7.77,\n \"dropRate\": 0.73,\n \"conversionRate\": 0,\n \"openRate\": 37.84,\n \"deliveryRate\": 98.28,\n \"unsubscribeRate\": 0.75\n },\n \"sms\": {\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 0,\n \"totalClicks\": 0,\n \"revenue\": 0,\n \"sent\": 0,\n \"smsMessageParts\": 0,\n \"unsubscribes\": 0,\n \"numberOfChannels\": 1,\n \"averageOrderValue\": 0,\n \"clickThroughRate\": 0,\n \"dropRate\": 0,\n \"conversionRate\": 0,\n \"deliveryRate\": 0,\n \"unsubscribeRate\": 0\n }\n },\n \"channelsByLayersMetrics\": {\n \"1\": [\n {\n \"sent\": 2,\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 2,\n \"totalClicks\": 0,\n \"revenue\": 0,\n \"averageOrderValue\": 0,\n \"conversionRate\": 0,\n \"dropRate\": 0,\n \"clickThroughRate\": 0,\n \"deliveryRate\": 100,\n \"layer\": 1,\n \"channel\": \"app-push\",\n \"channelName\": \"Paid Ads Lead Nurture_mobile App Push 1\",\n \"campaignId\": 4098\n },\n {\n \"sent\": 140,\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 137,\n \"totalClicks\": 67,\n \"uniqueClicks\": 11,\n \"totalOpens\": 66,\n \"uniqueOpens\": 44,\n \"revenue\": 0,\n \"unsubscribes\": 3,\n \"averageOrderValue\": 0,\n \"conversionRate\": 0,\n \"dropRate\": 0,\n \"clickThroughRate\": 8.03,\n \"openRate\": 32.12,\n \"deliveryRate\": 97.86,\n \"unsubscribeRate\": 2.19,\n \"layer\": 1,\n \"channel\": \"email\",\n \"channelName\": \"Paid Ads Lead Nurture_mobile Email 1\",\n \"campaignId\": 4104\n },\n {\n \"sent\": 0,\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 0,\n \"totalClicks\": 0,\n \"revenue\": 0,\n \"smsMessageParts\": 0,\n \"unsubscribes\": 0,\n \"averageOrderValue\": 0,\n \"conversionRate\": 0,\n \"dropRate\": 0,\n \"clickThroughRate\": 0,\n \"deliveryRate\": 0,\n \"unsubscribeRate\": 0,\n \"layer\": 1,\n \"channel\": \"sms\",\n \"channelName\": \"Paid Ads Lead Nurture_mobile SMS 1\",\n \"campaignId\": 4110\n }\n ],\n \"2\": [\n {\n \"sent\": 2,\n \"conversions\": 0,\n \"drops\": 0,\n \"delivered\": 2,\n \"totalClicks\": 0,\n \"revenue\": 0,\n \"averageOrderValue\": 0,\n \"conversionRate\": 0,\n \"dropRate\": 0,\n \"clickThroughRate\": 0,\n \"deliveryRate\": 100,\n \"layer\": 2,\n \"channel\": \"app-push\",\n \"channelName\": \"Paid Ads Lead Nurture_mobile App Push 2\",\n \"campaignId\": 4100\n }\n ]\n }\n}\n\n{\n \"error\": \"Invalid API key\"\n}\n\n{\n \"message\": \"The stat date field is required.\",\n \"errors\": {\n \"statDate\": [\n \"The stat date field is required.\"\n ]\n }\n}\n\nid: The unique ID of the conversion goal.
\nname: The name of the conversion goal.
\ntype: The type of conversion goal (e.g., on-event, on-attribute).
\nparameters: An array detailing the conditions for the goal, such as key-value pairs with operators and value types.
\njourneys: A list of journeys where the conversion goal is used, including journey IDs and names.
\nThe request must be executed with an HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nDefines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY
\n","type":"text/plain"},"key":"statDate","value":"String"},{"disabled":true,"description":{"content":"A number representing the conversion goal ID filter. Default is 0 which is the Purchase goal.
\n","type":"text/plain"},"key":"conversionGoal","value":"Integer"},{"disabled":true,"description":{"content":"Attribution type for reporting. 0 for Click-Through attribution (default). 1 for View-Through attribution.
\n","type":"text/plain"},"key":"goalType","value":"Integer"}],"variable":[]}},"response":[],"_postman_id":"306ea458-652c-41f5-8334-b143f9e08293"},{"name":"Get Architect Channel Analytics","id":"118409ba-35a8-4cf3-8a1a-64390df73123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter the word {{vault:bearer-token}} by the API key you generated.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"You should enter it as application/json at all times.
\n","type":"text"}],"url":"https://architect-analytics.api.useinsider.com/v1/element/{campaignId}?statDate=String","description":"The Architect channel analytics endpoint provides analytics for a specific campaign element in the Architect product. Use this endpoint to gather analytics data for individual campaign elements and track user interactions, click-through rates, open rates, and other relevant metrics.
\nThe statDate parameter is essential for defining the time range for analytics. The start date must be earlier than the end date. You can select any time range, including those longer than one year or before the past year. However, if you encounter a timeout when exporting a range longer than one year, try selecting a shorter range.
\nUse conversionGoal filter to tailor your analytics queries to specific requirements.
\nFor journey analytics, you can only get the conversion metrics for one goal at a time. You can enter the goal id as a parameter to select which conversion goal you want to see the metrics. You can obtain the Goal ID either from the goal dropdown in the InOne panel or by using the conversion goals information endpoint.
\n\n\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace campaignId with the specific campaign's ID. You can find this ID on the inner page of the element.
\ncurl -X GET \"https://architect-analytics.api.useinsider.com/v1/element/12345?statDate=01/08/2024 - 30/08/2024&conversionGoal=789&goalType=1\" \\\n -H \"Authorization: {{vault:bearer-token}}\" \\\n -H \"Accept: application/json\"\n\n{\n \"filterDate\": \"22/05/2024 - 11/11/2024\",\n \"attributionType\": \"Click-Through\",\n \"goal\": \"confirmation_page_view\",\n \"partner\": {\n \"exportTime\": \"11/11/2024 12:27\",\n \"accountName\": \"shopbagg\"\n },\n \"elementMetrics\": {\n \"averageOrderValue\": 0,\n \"block\": 95,\n \"bounce\": 0,\n \"bounceRate\": 0,\n \"clickThroughRate\": 1.49,\n \"clickToOpenRate\": 5.7,\n \"conversions\": 0,\n \"conversionRate\": 0,\n \"delivered\": 18889,\n \"deliveryRate\": 99.57,\n \"droppedMessages\": [],\n \"drops\": {\n \"frequencyDrops\": 0,\n \"frequencyDropPercentage\": 0,\n \"sendingDrops\": 98,\n \"sendingDropPercentage\": 100,\n \"systemDrops\": 0,\n \"systemDropPercentage\": 0\n },\n \"linkActivity\": [\n {\n \"link\": \"https://example.com/app/\",\n \"totalClick\": 910,\n \"uniqueClick\": 256\n },\n {\n \"link\": \"https://example.com/about/\",\n \"totalClick\": 211,\n \"uniqueClick\": 207\n },\n {\n \"link\": \"https://example.com/pay/\",\n \"totalClick\": 211,\n \"uniqueClick\": 208\n }\n ],\n \"machineOpen\": 0,\n \"openRate\": 26.2,\n \"revenue\": 0,\n \"sent\": 18971,\n \"spam\": 2,\n \"totalClicks\": 3896,\n \"totalOpens\": 6355,\n \"uniqueClicks\": 282,\n \"uniqueMachineOpens\": 3232,\n \"uniqueMachineOpensRate\": 17.11,\n \"uniqueOpens\": 4949,\n \"uniqueOpenRate\": 26.2,\n \"unsubscribe\": 15,\n \"unsubscribeRate\": 0.08\n }\n}\n\n{\n \"error\": \"Invalid API key\"\n}\n\n{\n \"message\": \"The stat date field is required.\",\n \"errors\": {\n \"statDate\": [\n \"The stat date field is required.\"\n ]\n }\n}\n\nid: The unique ID of the conversion goal.
\nname: The name of the conversion goal.
\ntype: The type of conversion goal (e.g., on-event, on-attribute).
\nparameters: An array detailing the conditions for the goal, such as key-value pairs with operators and value types.
\njourneys: A list of journeys where the conversion goal is used, including journey IDs and names.
\nThe request must be executed with an HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nA number representing the conversion goal ID filter. Default is 0 which is the Purchase goal.
\n","type":"text/plain"},"key":"conversionGoal","value":"Integer"},{"disabled":true,"description":{"content":"Attribution type for reporting. 0 for Click-Through attribution (default). 1 for View-Through attribution.
\n","type":"text/plain"},"key":"goalType","value":"Integer"},{"description":{"content":"Defines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY
\n","type":"text/plain"},"key":"statDate","value":"String"}],"variable":[]}},"response":[],"_postman_id":"118409ba-35a8-4cf3-8a1a-64390df73123"},{"name":"Get Conversion Goals Analytics","id":"007f2978-5566-4140-be19-1946a26238a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter the word {{vault:bearer-token}} by the API key you generated.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"You should enter it as application/json at all times.
\n","type":"text"}],"url":"https://architect-analytics.api.useinsider.com/v1/goals-analytics?statDate=statDate=01/08/2024 - 30/08/2024","description":"For overall and journey analytics, you can get all conversion metrics for all goals at the same time.
\nIf you provide the journey ID in the payload, you will also get that journey’s conversion metrics for goals. You should provide the journey ID inside the IDs filter array.
\nThis endpoint retrieves a list of conversion goals across various journeys. You can use the Conversion Goals Information API together with this API to combine conversion goal metrics and see which journeys they are used in.
\nBefore sending the request, make sure:
\nTo replace the authorization value with your own API key.
\nTo replace the sample values in parameters with your own values in the required data type.
\ncurl -X GET \"https://architect-analytics.api.useinsider.com/v1/goals-analytics\" \\\n-H \"Authorization: {{vault:bearer-token}}\" \\\n-H \"Accept: application/json\"\n\n{\n \"data\": [\n {\n \"conversionRateReference\": 35010,\n \"goalId\": 0,\n \"goalName\": \"confirmation_page_view\",\n \"conversion\": 4,\n \"conversionRate\": 0.01,\n \"revenue\": 123088700,\n \"aov\": 30772175\n },\n {\n \"conversionRateReference\": 35010,\n \"goalId\": 2,\n \"goalName\": \"item_added_to_cart\",\n \"conversion\": 30,\n \"conversionRate\": 0.09,\n \"revenue\": 565852200,\n \"aov\": 18861740\n },\n {\n \"conversionRateReference\": 35010,\n \"goalId\": 3,\n \"goalName\": \"product_detail_page_view\",\n \"conversion\": 125,\n \"conversionRate\": 0.36,\n \"revenue\": 11732341800,\n \"aov\": 93858734\n }\n ]\n}\n\n{\n \"error\": \"Invalid API key\"\n}\n\nThe request must be executed with an HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nDefines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY
\n","type":"text/plain"},"key":"statDate","value":"statDate=01/08/2024 - 30/08/2024"},{"disabled":true,"description":{"content":"Array filter for journey statuses. Default is active if not provided.\nAllowed values: active, test, passive, sunset
\n","type":"text/plain"},"key":"statuses","value":"statuses[]=active&statuses[]=passive"},{"disabled":true,"description":{"content":"Array filter specifying which channels' analytics data to return. If not provided, all channels are included.\nAllowed values: web-push, app-push, email, sms, whatsapp, in-app, journey-web, call-api
\n","type":"text/plain"},"key":"channels","value":"channels[]=email&channels[]=sms"},{"disabled":true,"description":{"content":"Array of journey IDs for filtering
\n","type":"text/plain"},"key":"ids","value":"ids[]=89&ids[]=90"},{"disabled":true,"description":{"content":"Attribution type for reporting.\n0 for Click-Through attribution (default)\n1 for View-Through attribution
\n","type":"text/plain"},"key":"goalType","value":"0"}],"variable":[]}},"response":[],"_postman_id":"007f2978-5566-4140-be19-1946a26238a5"},{"name":"Get Conversion Goals Information","id":"445eecad-04cb-4ac2-a44a-6c054cd1975e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","description":"This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter the word {{vault:bearer-token}} by the API key you generated.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"You should enter it as application/json at all times.
\n","type":"text"}],"url":"https://architect-analytics.api.useinsider.com/v1/goals","description":"For Architect overall, journey, and channel analytics, you can only get the conversion metrics for one goal at a time. You can enter the goal id as a parameter to select which conversion goal you want to see the metrics. You can obtain the Goal ID either from the goal dropdown in the InOne panel or by using this endpoint.
\nThis endpoint retrieves a list of conversion goals across various journeys in the Architect product, their IDs, and which journeys they are used in.
\nThis endpoint does not require any query parameters.
\nBefore sending the request, make sure:
\ncurl -X GET \"https://architect-analytics.api.useinsider.com/v1/goals\" \\\n -H \"Authorization: {{vault:bearer-token}}\" \\\n -H \"Accept: application/json\"\n\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"payment_successful\",\n \"type\": \"on-event\",\n \"parameters\": [\n [\n {\n \"key\": \"retailer_name\",\n \"operator\": \"cnt\",\n \"type\": \"string\",\n \"values\": [\n \"VCC\"\n ]\n }\n ]\n ],\n \"journeys\": [\n {\n \"id\": 89,\n \"name\": \"Journey Name 1\"\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"payment_failed\",\n \"type\": \"on-event\",\n \"parameters\": [\n [\n {\n \"key\": \"retailer_name\",\n \"operator\": \"cnt\",\n \"type\": \"string\",\n \"values\": [\n \"VCC\",\n \"Direct\"\n ]\n }\n ]\n ],\n \"journeys\": [\n {\n \"id\": 90,\n \"name\": \"Journey Name 2\"\n }\n ]\n }\n ]\n}\n\n{\n \"error\": \"Invalid API key\"\n}\n\nid: The unique ID of the conversion goal.
\nname: The name of the conversion goal.
\ntype: The type of conversion goal (e.g., on-event, on-attribute).
\nparameters: An array detailing the conditions for the goal, such as key-value pairs with operators and value types.
\njourneys: A list of journeys where the conversion goal is used, including journey IDs and names.
\nThe request must be executed with an HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter the word {{vault:bearer-token}} by the API key you generated.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"You should enter it as application/json at all times.
\n","type":"text"}],"url":"https://architect-analytics.api.useinsider.com/v1/journeys","description":"The Journey List API enables you to export detailed information for all journeys created in Architect. This endpoint provides metadata such as journey name, status, creation and execution dates, tags, conversion goals, and exit criteria — allowing you to easily audit, analyze, or back up journey configurations externally.
\nIt’s particularly useful for teams that want to integrate Architect data with external analytics platforms or maintain synchronized journey catalogs.
\n{\n \"journeys\": [\n {\n \"journeyId\": 5756,\n \"parentJourneyId\": 38,\n \"journeyName\": \"Demo Journey\",\n \"status\": \"active\",\n \"createdAt\": \"2025-10-14T11:42:29.000000Z\",\n \"startDate\": \"2025-10-14T11:44:53.000000Z\",\n \"endDate\": \"2025-11-13T11:42:45.000000Z\",\n \"tags\": [\"Demo\"],\n \"description\": null,\n \"starterType\": \"on-event\",\n \"languages\": [\"ar_AE\", \"ja_JP\", \"ka_GA\"],\n \"reEligibility\": {\n \"rule\": \"Users re-enter after 3 day\",\n \"value\": 3\n },\n \"conversionGoals\": [\n {\n \"id\": 216,\n \"event\": \"confirmation_page_view\",\n \"eventParameters\": [\n {\n \"display_name\": \"Event Source\",\n \"key\": \"source\",\n \"operator\": \"eq\",\n \"type\": \"string\",\n \"values\": [\"crm\", \"mobile\"]\n }\n ]\n }\n ],\n \"exitCriteria\": [\n {\n \"event\": \"item_added_to_cart\",\n \"parameters\": {\n \"name\": \"item_added_to_cart\",\n \"type\": \"event\",\n \"params\": [],\n \"identifierParameter\": \"\",\n \"hash\": \"item_added_to_cartnacntstring3/4 Sleeve Kimono DressProduct Name\",\n \"consistencyStatus\": false,\n \"groupPartners\": [],\n \"value\": \"item_added_to_cart\"\n }\n },\n {\n \"event\": \"login\",\n \"parameters\": {\n \"name\": \"login\",\n \"type\": \"event\",\n \"params\": [],\n \"identifierParameter\": \"\",\n \"hash\": \"login\",\n \"consistencyStatus\": false,\n \"groupPartners\": [],\n \"value\": \"login\"\n }\n }\n ],\n \"campaigns\": [\n {\n \"id\": 64592,\n \"name\": \"Demo Journey Web Push 1\",\n \"channel\": \"Web Push\"\n },\n {\n \"id\": 64596,\n \"name\": \"Demo Journey Web Push 2\",\n \"channel\": \"Web Push\"\n },\n {\n \"id\": 64595,\n \"name\": \"Demo Journey SMS 2\",\n \"channel\": \"SMS\"\n },\n {\n \"id\": 64599,\n \"name\": \"Demo Journey SMS 1\",\n \"channel\": \"SMS\"\n },\n {\n \"id\": 64591,\n \"name\": \"Demo Journey On-Site 1\",\n \"channel\": \"On-Site\"\n }\n ]\n }\n ]\n}\n\n\n{\n \"error\": \"Invalid API key\"\n}\n\nThe request must be executed with an HTTPS GET request.
\nThe API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
\nFilters journeys by status.\nAllowed values are active, test, passive, sunset.
\n","type":"text/plain"},"key":"statuses","value":"?statuses[]=active&statuses[]=test"},{"disabled":true,"description":{"content":"Filters by specific journey IDs
\n","type":"text/plain"},"key":"ids","value":"?ids[]=1&ids[]=2&ids[]=3"},{"disabled":true,"description":{"content":"Returns journeys whose names partially match the provided text.
\n","type":"text/plain"},"key":"search","value":"?search=welcome"},{"disabled":true,"description":{"content":"Filters journeys by their assigned tags. Each tag must exist in the tags table.
\n","type":"text/plain"},"key":"tags","value":"?tags[]=cart%20abandonment&tags[]=retention"},{"disabled":true,"description":{"content":"Pagination for the export. You can determine which page and for what limit you want to get an export for. You can get at most 300 journeys per export.
\n","type":"text/plain"},"key":"limit,page","value":"?limit=100&page=1"}],"variable":[]}},"response":[],"_postman_id":"075b5dc2-29d8-4539-bef1-1dc0a037d953"}],"id":"573cd59c-65b7-4dbd-b07f-b95ab912b48a","_postman_id":"573cd59c-65b7-4dbd-b07f-b95ab912b48a","description":""}],"id":"167f3b10-62e6-4115-9263-bee535afec92","description":"Reports & Analysis APIs allow you to get the campaign analytics from your own back-end without using the Insider's Inone panel. As a result, you can analyze your users' engagement, and manage your campaigns accordingly.
\n","_postman_id":"167f3b10-62e6-4115-9263-bee535afec92"}],"event":[{"listen":"prerequest","script":{"id":"90f245e2-4a94-42f3-afc1-818377e36dac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9cd90813-7f1c-4d81-83ae-c67755569286","type":"text/javascript","exec":[""]}}],"variable":[{"id":"3738420f-0982-4cd3-8e08-2df8bab972a7","key":"X-PARTNER-NAME","value":""},{"id":"5df61b0c-97e5-4620-b7db-7ccc83332c53","key":"X-REQUEST-TOKEN","value":""},{"id":"600d42f9-3d20-47fb-8e33-e7080b18eb64","key":"transactionalEmailApiKey","value":""},{"id":"5c9e75d5-5079-48f6-8345-c6e17fa81d95","key":"emailContentApiKey","value":""},{"id":"08227a9a-192e-4d71-a676-5aaf0ce9424a","key":"webPushAuthorizationKey","value":"Bearer"},{"id":"77bcf3f5-e617-4379-b713-aa0d9af2866b","key":"emailCampaignAnalyticsApiKey","value":""},{"id":"7b0f275a-caab-4e66-b721-ddb465fb44f1","key":"onsiteCampaignAnalyticsApiKey","value":""},{"id":"6befcb4d-e2ac-4a70-8333-1278b6e55b63","key":"globalUnsubscribeApiKey","value":""},{"id":"12e08a3d-9fc7-4aab-bfb9-95b0daca2bc1","key":"resubscribeApiKey","value":""},{"id":"207d77d1-96ed-45b0-85a4-1bd9a73d00bc","key":"firstPartySegmentsApiKey","value":""},{"id":"eab7e6ba-cec5-48e1-b9be-378621d279c3","key":"mobileAppApiKey","value":""},{"id":"0940a8d7-43c3-4dbc-b2cd-028511976446","key":"partnerName","value":""},{"id":"ce657a73-e924-4e35-bcbe-c5431b680286","key":"transactionalWhatsappApiKey","value":""}]}