Get Conversion Goals Information

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. 

This endpoint retrieves a list of conversion goals across various journeys in the Architect product, their IDs, and which journeys they are used in.

Endpoint and Headers

GET https://architect-analytics.api.useinsider.com/v1/goals

Headers

Query Parameters

This endpoint does not require any query parameters.

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" \
  -H "Authorization: Bearer 1a2b3c4d5e6f" \
  -H "Accept: application/json"

Sample Response

200 OK

{
    "data": [
        {
            "id": 1,
            "name": "payment_successful",
            "type": "on-event",
            "parameters": [
                [
                    {
                        "key": "retailer_name",
                        "operator": "cnt",
                        "type": "string",
                        "values": [
                            "VCC"
                        ]
                    }
                ]
            ],
            "journeys": [
                {
                    "id": 89,
                    "name": "Journey Name 1"
                }
            ]
        },
        {
            "id": 2,
            "name": "payment_failed",
            "type": "on-event",
            "parameters": [
                [
                    {
                        "key": "retailer_name",
                        "operator": "cnt",
                        "type": "string",
                        "values": [
                            "VCC",
                            "Direct"
                        ]
                    }
                ]
            ],
            "journeys": [
                {
                    "id": 90,
                    "name": "Journey Name 2"
                }
            ]
        }
    ]
}

401 Unauthorized

{
    "error": "Invalid API key"
}

Response Details

• id: The unique ID of the conversion goal.
• name: The name of the conversion goal.
• type: The type of conversion goal (e.g., on-event, on-attribute).
• parameters: An array detailing the conditions for the goal, such as key-value pairs with operators and value types.
• journeys: A list of journeys where the conversion goal is used, including journey IDs and names.

Limitations

• The request must be executed with an HTTPS GET request.
• The 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.
• You can send 100 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.