Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.1.0
info:
title: Insider One Architect Analytics API
version: 1.0.0
description: 'Architect journey analytics: overall, per-journey, per-element, conversion goals and journey export.
Derived by API Evangelist from Insider One''s own public Postman collection ("Insider One APIs", published at
https://developers.insiderone.com/). Paths, methods, headers, query parameters and request/response examples
are verbatim from that collection; nothing is invented. The 429 response is documented for all Insider One APIs
on https://academy.insiderone.com/docs/api-rate-limits-1 .'
contact:
name: Insider One Support
email: support@useinsider.com
url: https://academy.insiderone.com/docs/insider-one-apis-1
termsOfService: https://insiderone.com/terms-of-use/
externalDocs:
description: Insider One API reference
url: https://academy.insiderone.com/docs/api-reference-welcome
servers:
- url: https://architect-analytics.api.useinsider.com
tags:
- name: Architect
paths:
/v1/element/{campaignId}:
get:
operationId: getArchitectChannelAnalytics
summary: Get Architect Channel Analytics
tags:
- Architect
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.\n\nHeaders\n\
\nHeader\nSample Value\nDescription\n\nAuthorization\n{{vault:bearer-token}}\nThis key is required to authorize\
\ your request. Refer to API Authentication Tokens to generate your token. You should enter the word Bearer\
\ followed by the API key you generated.\n\nAccept\napplication/json\nYou should enter it as application/json\
\ at all times.\n\nQuery Parameters\n\nParameter\nData Type\nDescription\nSample Value\nRequired\n\nstatDate\n\
String\nDefines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY\nstatDate=01/08/2024 - 30/08/2024\n\
Yes\n\nconversionGoal\nInteger\nA number representing the conversion goal ID filter. Default is 0 which\
\ is the Purchase goal.\nconversionGoal=123\nNo\n\ngoalType\nInteger\nAttribution type for reporting. 0\
\ for Click-Through attribution (default). 1 for View-Through attribution.\n0\nNo\n\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.\n\
\nUse conversionGoal filter to tailor your analytics queries to specific requirements.\n\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\nSample Example\n\
Sample Query\nBefore sending the request, make sure:\n\nTo replace the authorization value with your own\
\ API key.\n\nTo replace campaignId with the specific campaign's ID. You can find this ID on the inner page\
\ of the element.\n\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\nSample Responses\n200 OK\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\n401 Unauthorized\n{\n \"error\": \"Invalid API key\"\n}\n\n422 Bad Request\n{\n \"message\"\
: \"The stat date field is required.\",\n \"errors\": {\n \"statDate\": [\n \"The stat\
\ date field is required.\"\n ]\n }\n}\n\nResponse Details\n\nid: The unique ID of the conversion\
\ goal.\n\nname: The name of the conversion goal.\n\ntype: The type of conversion goal (e.g., on-event,\
\ on-attribute).\n\nparameters: An array detailing the conditions for the goal, such as key-value pairs\
\ with operators and value types.\n\njourneys: A list of journeys where the conversion goal is used, including\
\ journey IDs and names.\n\nLimitations\n\nThe request must be executed with an HTTPS GET request.\n\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.\n\nYou can send\
\ 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error."
parameters:
- name: campaignId
in: path
required: true
schema:
type: string
- name: statDate
in: query
required: false
schema:
type: string
example: String
security:
- Authorization: []
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/goals:
get:
operationId: getConversionGoalsInformation
summary: Get Conversion Goals Information
tags:
- Architect
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.\n\nThis endpoint retrieves a list of conversion goals across various journeys in\
\ the Architect product, their IDs, and which journeys they are used in.\n\nHeaders\n\nHeader\nSample Value\n\
Description\n\nAuthorization\n{{vault:bearer-token}}\nThis key is required to authorize your request. Refer\
\ to API Authentication Tokens to generate your token. You should enter the word Bearer followed by the\
\ API key you generated.\n\nAccept\napplication/json\nYou should enter it as application/json at all times.\n\
\nQuery Parameters\nThis endpoint does not require any query parameters.\n\nSample Example\nSample Query\n\
Before sending the request, make sure:\n\nTo replace the authorization value with your own API key.\n\n\
curl -X GET \"https://architect-analytics.api.useinsider.com/v1/goals\" \\\n -H \"Authorization: {{vault:bearer-token}}\"\
\ \\\n -H \"Accept: application/json\"\n\nSample Response\n200 OK\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\n401 Unauthorized\n{\n \"error\": \"Invalid\
\ API key\"\n}\n\nResponse Details\n\nid: The unique ID of the conversion goal.\n\nname: The name of the\
\ conversion goal.\n\ntype: The type of conversion goal (e.g., on-event, on-attribute).\n\nparameters: An\
\ array detailing the conditions for the goal, such as key-value pairs with operators and value types.\n\
\njourneys: A list of journeys where the conversion goal is used, including journey IDs and names.\n\nLimitations\n\
\nThe request must be executed with an HTTPS GET request.\n\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.\n\nYou can send 200 requests per minute with the same API Key. If you\
\ exceed the rate limit, you will receive a 429 error."
security:
- Authorization: []
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/goals-analytics:
get:
operationId: getConversionGoalsAnalytics
summary: Get Conversion Goals Analytics
tags:
- Architect
description: "For overall and journey analytics, you can get all conversion metrics for all goals at the same\
\ time.\n\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.\n\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.\n\nHeaders\n\
\nHeader\nSample Value\nDescription\n\nAuthorization\n{{vault:bearer-token}}\nThis key is required to authorize\
\ your request. Refer to API Authentication Tokens to generate your token. You should enter the word Bearer\
\ followed by the API key you generated.\n\nAccept\napplication/json\nYou should enter it as application/json\
\ at all times.\n\nQuery Parameters\n\nParameter\nDescription\nSample Value\nRequired\n\nstatDate\nDefines\
\ the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY\nstatDate=01/08/2024 - 30/08/2024\nYes\n\
\nstatuses\nArray filter for journey statuses. Default is active if not provided. Allowed values: active,\
\ test, passive, sunset\nstatuses[]=active&statuses[]=passive\nNo\n\nchannels\nArray filter specifying which\
\ channels' analytics data to return. If not provided, all channels are included. Allowed values: web-push,\
\ app-push, email, sms, whatsapp, in-app, journey-web, call-api\nchannels[]=email&channels[]=sms\nNo\n\n\
ids\nArray of journey IDs for filtering\nids[]=89&ids[]=90\nNo\n\ngoalType\nAttribution type for reporting.\
\ 0 for Click-Through attribution (default) 1 for View-Through attribution\n0\nNo\n\nSample Example\n\
Sample Query\nBefore sending the request, make sure:\n\nTo replace the authorization value with your own\
\ API key.\n\nTo replace the sample values in parameters with your own values in the required data type.\n\
\ncurl -X GET \"https://architect-analytics.api.useinsider.com/v1/goals-analytics\" \\\n-H \"Authorization:\
\ {{vault:bearer-token}}\" \\\n-H \"Accept: application/json\"\n\nSample Responses\n200 OK\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\n401 Unauthorized\n{\n \"error\": \"Invalid API\
\ key\"\n}\n\nLimitations\n\nThe request must be executed with an HTTPS GET request.\n\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.\n\nYou can send 200 requests per\
\ minute with the same API Key. If you exceed the rate limit, you will receive a 429 error."
parameters:
- name: statDate
in: query
required: false
schema:
type: string
example: statDate=01/08/2024 - 30/08/2024
security:
- Authorization: []
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/journey/{journeyId}:
get:
operationId: getArchitectJourneyAnalytics
summary: Get Architect Journey Analytics
tags:
- Architect
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.\n\nHeaders\n\nHeader\nSample Value\nDescription\n\nAuthorization\n\
{{vault:bearer-token}}\nThis key is required to authorize your request. Refer to API Authentication Tokens\
\ to generate your token. You should enter the word Bearer followed by the API key you generated.\n\nAccept\n\
application/json\nYou should enter it as application/json at all times.\n\nQuery Parameters\n\nParameter\n\
Data Type\nDescription\nSample Value\nRequired\n\nstatDate\nString\nDefines the date range for statistics.\
\ Format: DD/MM/YYYY - DD/MM/YYYY\nstatDate=01/08/2024 - 30/08/2024\nYes\n\nconversionGoal\nInteger\nA number\
\ representing the conversion goal ID filter. Default is 0 which is the Purchase goal.\nconversionGoal=123\n\
No\n\ngoalType\nInteger\nAttribution type for reporting. 0 for Click-Through attribution (default). 1 for\
\ View-Through attribution.\n0\nNo\n\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.\n\nUse conversionGoal filter to tailor your\
\ analytics queries to specific requirements.\n\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\nSample Example\nSample Query\nBefore sending\
\ the request, make sure:\n\nTo replace the authorization value with your own API key.\n\nTo replace journeyId\
\ with the specific journey's ID.\n\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\nSample Responses\n200 OK\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 \"channelsMetrics\"\
: [\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 \"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 \"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 \"channel\": \"\
sms\",\n \"channelName\": \"Paid Ads Lead Nurture_mobile SMS 1\",\n \"campaignId\"\
: 4110\n },\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 \"channel\": \"app-push\"\
,\n \"channelName\": \"Paid Ads Lead Nurture_mobile App Push 2\",\n \"campaignId\"\
: 4100\n }\n ]\n}\n\n401 Unauthorized\n{\n \"error\": \"Invalid API key\"\n}\n\n422 Bad Request\n\
{\n \"message\": \"The stat date field is required.\",\n \"errors\": {\n \"statDate\": [\n\
\ \"The stat date field is required.\"\n ]\n }\n}\n\nResponse Details\n\nid: The unique\
\ ID of the conversion goal.\n\nname: The name of the conversion goal.\n\ntype: The type of conversion goal\
\ (e.g., on-event, on-attribute).\n\nparameters: An array detailing the conditions for the goal, such as\
\ key-value pairs with operators and value types.\n\njourneys: A list of journeys where the conversion goal\
\ is used, including journey IDs and names.\n\nLimitations\n\nThe request must be executed with an HTTPS\
\ GET request.\n\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.\n\
\nYou can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive\
\ a 429 error."
parameters:
- name: journeyId
in: path
required: true
schema:
type: string
- name: statDate
in: query
required: false
schema:
type: string
example: String
security:
- Authorization: []
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/journeys:
get:
operationId: exportJourneyList
summary: Export Journey List
tags:
- Architect
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.\n\nIt’s particularly useful for teams that want to integrate Architect data\
\ with external analytics platforms or maintain synchronized journey catalogs.\n\nQuery Parameters\n\nParameter\n\
Description\nSample Value\nRequired\n\nstatuses\nFilters journeys by status. Allowed values are active,\
\ test, passive, sunset.\n?statuses[]=active&statuses[]=test\nNo\n\nids\nFilters by specific journey IDs\n\
?ids[]=1&ids[]=2&ids[]=3\nNo\n\nsearch\nReturns journeys whose names partially match the provided text.\n\
?search=welcome\nNo\n\ntags\nFilters journeys by their assigned tags. Each tag must exist in the tags table.\n\
?tags[]=cart abandonment&tags[]=retention\nNo\n\nlimit, page\nPagination 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\
?limit=100&page=1 → Brings the 100 journeys of the first page. If you have 900 journeys, and you want to\
\ get an export for all of them, you need 3 API calls: ?limit=300&page=1 ?limit=300&page=2 ?limit=300&page=3\n\
No\n\nSample Responses\n200 OK\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\n401 Unauthorized\n{\n \"error\": \"Invalid API key\"\n}\n\nLimitations\n\n\
The request must be executed with an HTTPS GET request.\n\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.\n\nYou can send 200 requests per minute with the same API Key. If you\
\ exceed the rate limit, you will receive a 429 error."
security:
- Authorization: []
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/overall:
get:
operationId: getArchitectOverallAnalytics
summary: Get Architect Overall Analytics
tags:
- Architect
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.\n\
\nHeaders\n\nHeader\nSample Value\nDescription\n\nAuthorization\n{{vault:bearer-token}}\nThis key is required\
\ to authorize your request. Refer to API Authentication Tokens to generate your token. You should enter\
\ the word Bearer followed by the API key you generated.\n\nAccept\napplication/json\nYou should enter it\
\ as application/json at all times.\n\nQuery Parameters\n\nParameter\nData Type\nDescription\nSample Value\n\
Required\n\nstatDate\nString\nDefines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY\nstatDate=01/08/2024\
\ - 30/08/2024\nYes\n\nstatuses\nArray of Strings\nArray filter for journey statuses. Default is active\
\ if not prov
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/insider/refs/heads/main/openapi/insider-architect-analytics-openapi.yml