Conversion Postback

This endpoint is protected and requires a public API key for access.

  curl --request POST \
    --url 'http://gc-api-prod.us-east-1.elasticbeanstalk.com/api/public/growth-channel-postback/' \
    --header 'Content-Type: application/json' \
    --header 'X-Api-Key: YOUR_PUBLIC_API_KEY' \
    --data '{
      "ref_id": "abc123xyz",
      "event_name": "user_converted",
      "revenue": 123,
      "conversion_data": {
        "order_id": "order_98765",
        "lead_source": "callrail"
      }
    }'

Method

POST

Endpoint

/api/public/growth-channel-postback/

Overview

Use this endpoint to send server-side conversion events to Growth Channel. The client should capture a unique tracking ID from the campaign landing URL and send it back when a conversion happens.

Send ref_id for every conversion. Add event_name, revenue, tracker_id, and conversion_data when you need more specific attribution or reporting metadata.

Headers

string

required

Your public API key for authorization.

string

required

Must be application/json.

Body

string

required

Unique tracking ID captured from the landing page URL.

string

Conversion tracker ID when the conversion should be attributed to a specific tracker.

string

Name of the conversion event, for example user_converted or phone_call.

number

Revenue amount for the conversion.

object

Additional metadata for the conversion.

Show object

string

Order or transaction identifier.

string

Source associated with the lead or conversion.

number

Call duration in seconds.

string

Customer category or segment.

Setup Guide

Add a tracking ID to the landing URL

Add a tracking ID macro to the campaign landing URL.

https://example.com/track?ref_id={TRACKING_ID}

Capture the tracking ID

Capture and store ref_id when the visitor lands on the site.

Send the conversion

When the user converts, send ref_id to this endpoint with optional event_name, revenue, and conversion_data.

Use a tracker when needed

Use tracker_id only when attribution should go to a specific conversion tracker.

Example

{
  "ref_id": "abc123xyz",
  "event_name": "user_converted",
  "revenue": 123,
  "conversion_data": {
    "order_id": "order_98765",
    "lead_source": "callrail"
  }
}

Responses

200 OK
400 Bad Request
401 Unauthorized
502 Bad Gateway

{
  "status": "ok"
}

string

Request status value.

Returned if the request body is invalid or ref_id is missing.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Missing required field: ref_id",
    "request_id": "..."
  }
}

Returned if the X-Api-Key header is missing or invalid.

Returned if the conversion provider is temporarily unavailable.

{
  "error": {
    "code": "CONVERSION_PROVIDER_UNAVAILABLE",
    "message": "Conversion provider temporarily unavailable",
    "request_id": "..."
  }
}

API documentation

Public endpoints

Method

Endpoint

Overview

Headers

Body

Setup Guide

Example

Responses

Method

Endpoint

​Overview

​Headers

​Body

​Setup Guide

​Example

​Responses

Overview

Headers

Body

Setup Guide

Example

Responses