API Documentation

POST /deep/api/v1/attribution/event

Use this endpoint to track user events related to deep links.

Headers:

                Content-Type: application/json
                Authorization: Bearer YOUR_API_KEY
                            

Request Body:

You can send either of the following request bodies:

                {
                    "click_id": "abc123",
                    "event_data": {
                        "value": 50,
                        "currency": "USD"
                    }
                }
                            

or

                {
                    "click_id": "abc123"
                }
                            

Response Example:

                {
                    "status": "success",
                    "message": "Event recorded successfully",
                    "event_id": "evt_456xyz"
                }
                            

Notes:

• Replace click_id with the dynamically generated value from the deep link. The click_id is typically generated when a user clicks on a deep link and is used to track the origin of the event.
• Customize event_data as per your use case.
• To generate your API Key, go to the Settings page of your dashboard (e.g., in your dashboard's user settings) and click Generate API Key. Copy the key using the provided button.
• Use this API to track user actions such as purchases, signups, or any other key events.
• Ensure that the Authorization header is included in every API request for security.

GET /deep/api/v1/deeplinks/{deeplink_id}/events/

Use this endpoint to retrieve all events associated with a specific deep link.

Headers:

                Content-Type: application/json
                Authorization: Bearer YOUR_API_KEY
                            

Request Example:

                GET /deep/api/v1/deeplinks/123/events/
                            

Response Example:

                {
                    "events": [
                        {
                            "click_id": "abc123",
                            "event_name": "purchase",  // Consider documenting or removing this field
                            "event_data": {
                                "value": 50,
                                "currency": "USD"
                            },
                            "timestamp": "2024-06-01T12:34:56Z"
                        },
                        {
                            "click_id": "def456",
                            "event_name": "signup", // Consider documenting or removing this field
                            "event_data": {},
                            "timestamp": "2024-06-02T08:22:15Z"
                        }
                    ]
                }
                            

Notes:

• Replace {deeplink_id} with the ID of the deep link you want to query.
• Ensure your request includes a valid API key in the Authorization header.
• The response will return a list of all events associated with the deep link, including timestamps.
• To generate your API Key, go to the Settings page of your dashboard (e.g., in your dashboard's user settings) and click Generate API Key. Copy the key using the provided button.