Brand Metrics and Conversion API Documentation

Access affiliate performance data from your Inflektion account. Pull summary reports, conversion-level logs, and affiliate details.

Overview

The Brand Metrics API gives brands programmatic access to the affiliate performance data flowing through Inflektion. It is organized around REST principles and uses standard HTTP verbs, status codes, and JSON request/response bodies.

The API is organized into the following capabilities:

• Summary Reporting: Aggregate metrics grouped by affiliate, date, geography, or other dimensions. Ideal for leaderboards and time-series charts.
• Conversion Log: Transaction-level detail for every conversion and (optionally) on-site event. Ideal for daily syncs into a data warehouse or BI tool.
• Edit Conversion: Update the sale amount on an existing conversion. Revenue and payout are adjusted automatically when applicable.
• Delete Conversion: Remove a conversion from the record.
• Affiliate Details: Active affiliate roster with contract tier, join date, and referral tree data.

Authentication

All requests must be authenticated with a Bearer token in the Authorization header. Your API key is provided by your Inflektion account manager if you're on the Growth or Enterprise plans.

Authorization: Bearer YOUR_API_KEY

Base URL

All requests are made over HTTPS to https://brand-api.inflektion.io

Request bodies (where applicable) must be JSON with the "Content-Type" header set to "application/json".

Pagination

Endpoints that return lists include a "paging" object in the response body:

{
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_count": 150
  }
}

Pages are 1-indexed (the first page is 1, not 0). When no pagination parameters are specified, the API returns the first page with a default page_size of 50. The maximum page size is 2000 unless an endpoint specifies otherwise.

To request a specific page, include page and page_size as query string parameters on GET endpoints, or as fields in the JSON body on POST endpoints.

Timezones

Every reporting request must include a timezone_id to anchor date ranges correctly. Common timezone IDs:

If you need a timezone ID not listed here, contact your Inflektion account manager.

Summary Reporting

POST /api/reporting/entity

Returns aggregate performance metrics grouped by one or more dimensions, similar to a pivot table. Use this endpoint to build leaderboards, time-series charts, or summary dashboards.

Request Body

Available Columns

Response Structure

The response contains three objects:

summary: Aggregate metrics for the entire date range across all groupings.

performance: Time-series data for building aggregate charts. The granularity adapts to the date range automatically:

• 1 day — 96 intervals of 15 minutes
• 2–3 days — 1-hour intervals
• 4–7 days — 6-hour intervals
• 8–14 days — 12-hour intervals
• >14 days — Daily intervals

table: Aggregate metrics broken down by the requested grouping column(s). Limited to 10,000 rows. Ideal for leaderboard/dashboard views.

Example Request

View aggregate data, grouped by affiliate_id, for the months of August through November 2025.

curl --request POST 'https://brand-api.inflektion.io/api/reporting/entity' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "from": "2025-08-01",
    "to": "2025-11-30",
    "timezone_id": 90,
    "currency_id": "USD",
    "query": {
      "filters": [],
      "search_terms": []
    },
    "columns": [
      { "column": "affiliate_id" }
    ]
  }'

Conversion Log

POST /api/reporting/conversions

Returns transaction-level data for individual conversions and (optionally) on-site events such as Add to Cart. Results are paginated.

Request Body

Example Request

curl --request POST 'https://brand-api.inflektion.io/api/reporting/conversions' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "show_conversions": true,
    "show_events": false,
    "show_only_vt": false,
    "show_only_ct": false,
    "from": "2025-11-30",
    "to": "2025-11-30",
    "timezone_id": 90,
    "currency_id": "USD",
    "query": {
      "filters": [],
      "search_terms": []
    }
  }'

Example Response

{
  "conversions": [
    {
      "conversion_id": "9008277d544441a7bc0c64533ccbbad8",
      "conversion_unix_timestamp": 1764489640,
      "cost_type": "RPS",
      "cost": 8.09,
      "session_user_ip": "203.0.113.42",
      "conversion_user_ip": "203.0.113.42",
      "country": "United States",
      "region": "California",
      "city": "Los Angeles",
      "dma": 0,
      "carrier": "",
      "platform": "iOS",
      "os_version": "",
      "device_type": "Phone",
      "brand": "Apple",
      "browser": "Safari",
      "language": "en",
      "http_user_agent": "Mozilla/5.0 ...",
      "is_event": false,
      "transaction_id": "41c9b30abde3434db512025fab386952",
      "click_unix_timestamp": 1764489486,
      "event": "Purchase",
      "currency_id": "USD",
      "isp": "",
      "adv1": "",
      "adv2": "",
      "adv3": "",
      "adv4": "couponcode",
      "adv5": "",
      "sale_amount": 53.91,
      "relationship": {
        "offer": {
          "network_offer_id": 123,
          "network_id": 888,
          "name": "Your Brand",
          "offer_status": "active"
        },
        "events_count": 0,
        "affiliate_id": 123456,
        "affiliate": {
          "network_affiliate_id": 123456,
          "network_id": 888,
          "name": "Sample Affiliate",
          "account_status": "active"
        },
        "sub1": "",
        "sub2": "",
        "sub3": "",
        "sub4": "",
        "sub5": "",
        "source_id": "",
        "offer_url": null
      },
      "coupon_code": "brand-affiliate"
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 50,
    "total_count": 271
  }
}

Suggested Fields to Log

When ingesting Conversion Log data into your own systems, we recommend storing at minimum the following fields:

Edit Conversion

PUT /api/reporting/conversions/{conversion_id}/saleamount

Updates the sale amount on an existing conversion. Revenue and payout are adjusted automatically when applicable.

Query Parameters

Request Body

Example Request

curl --location --request PUT 'https://brand-api.inflektion.io/api/reporting/conversions/{conversion_id}/saleamount' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "sale_amount": 199.00
  }'

Delete Conversion

DELETE /api/reporting/conversions/{conversion_id}

Deletes a conversion from the record.

Query Parameters

Example Request

curl --location --request DELETE 'https://brand-api.inflektion.io/api/reporting/conversions/{conversion_id}' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Affiliate Details

GET /api/affiliates?page={page}&page_size={page_size}

Returns a paginated list of all active affiliates in your program, including their contract tier, join date, and referral chain.

Query Parameters

Response Fields

Example Request

curl --request GET 'https://brand-api.inflektion.io/api/affiliates?page=1&page_size=10' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "affiliates": [
    {
      "network_affiliate_id": 1100,
      "name": "Sample Affiliate 1",
      "time_created": "1597650357",
      "referrer_id": 1000,
      "contract_name": "Bronze",
      "type": "Influencer"
    },
    {
      "network_affiliate_id": 1200,
      "name": "Sample Affiliate 2",
      "time_created": "1611038247",
      "referrer_id": null,
      "contract_name": "Gold",
      "type": "Brand Ambassador"
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 10,
    "total_count": 500
  }
}

Error Handling

The API uses standard HTTP status codes. Errors return a JSON body with a descriptive message.

Rate Limits

API requests are rate-limited per API key. If you receive a 429 response, implement an exponential backoff strategy before retrying. For high-volume integrations or real-time use cases, contact your Inflektion account manager to discuss elevated rate limits.

Need help?

Reach out to your Inflektion account manager.