For overall and journey analytics, you can get all conversion metrics for all goals at the same time.
If 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.
This 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.
Endpoint and Headers
GET https://architect-analytics.api.useinsider.com/v1/goals-analytics
Visit our Postman collection to test this request.
Header | Sample Value | Description |
|---|---|---|
Authorization | Bearer 1a2b3c4d5e6f | This 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. |
Accept | application/json | You should enter it as application/json at all times. |
Query Parameters
Parameter | Description | Sample Value | Required |
|---|---|---|---|
statDate | Defines the date range for statistics. Format: DD/MM/YYYY - DD/MM/YYYY | statDate=01/08/2024 - 30/08/2024 | Yes |
statuses | Array filter for journey statuses. Default is active if not provided. | statuses[]=active&statuses[]=passive | No |
channels | Array filter specifying which channels' analytics data to return. If not provided, all channels are included. | channels[]=email&channels[]=sms | No |
ids | Array of journey IDs for filtering | ids[]=89&ids[]=90 | No |
goalType | Attribution type for reporting. | 0 | No |
Sample Example
Sample Query
Before sending the request, make sure to replace the authorization value with your own API key.
curl -X GET "https://architect-analytics.api.useinsider.com/v1/goals-analytics" \
-H "Authorization: Bearer INS.1a2b3c4d" \
-H "Accept: application/json"Sample Response
200 OK
{
"data": [
{
"conversionRateReference": 35010,
"goalId": 0,
"goalName": "confirmation_page_view",
"conversion": 4,
"conversionRate": 0.01,
"revenue": 123088700,
"aov": 30772175
},
{
"conversionRateReference": 35010,
"goalId": 2,
"goalName": "item_added_to_cart",
"conversion": 30,
"conversionRate": 0.09,
"revenue": 565852200,
"aov": 18861740
},
{
"conversionRateReference": 35010,
"goalId": 3,
"goalName": "product_detail_page_view",
"conversion": 125,
"conversionRate": 0.36,
"revenue": 11732341800,
"aov": 93858734
}
]
}401 Unauthorized
{
"error": "Invalid API key"
}Limitations
The request must be executed with an HTTPS GET request.
The 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.
You can send 200 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.
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.