Skip to content

products-api.md

Latest commit

 

History

History
224 lines (186 loc) · 5.94 KB

products-api.md

File metadata and controls

224 lines (186 loc) · 5.94 KB

Products API

Products are listed through the Subscriptions API. Payload definitions — which provide the stage_id values needed for subscriptions and history requests — are fetched from the Products API. This document covers both calls.

Base URLs

Endpoint Base URL
List products https://subscriptions.api.openbridge.io
Product payload definitions (via proxy) https://service.api.openbridge.io/service/products

Authentication

All requests require a JWT access token passed as a Bearer token:

Authorization: Bearer {your_access_token}

Obtain an access token by posting your refresh token to the Authentication API. See Authentication API for the full flow.

Endpoints

List Products

Returns all available products. Use the id field as the product value when creating a subscription or as product_id in History API requests.

GET https://subscriptions.api.openbridge.io/product

Returns only active products by default (active=1). Pass active=0 to list inactive products.

Query filters:

  • active={0|1} — filter by active status (default: 1)
  • is_storage_product={0|1} — 1 for destination products, 0 for source products
  • remote_identity_type={id} — filter by required remote identity type
  • name={value} — exact name match
  • name__icontains={value} — case-insensitive name substring
  • page={n} — page number

Example response:

{
  "links": {
    "first": "https://subscriptions.api.openbridge.io/product?page=1",
    "last": "https://subscriptions.api.openbridge.io/product?page=4",
    "next": "https://subscriptions.api.openbridge.io/product?page=2",
    "prev": ""
  },
  "data": [
    {
      "type": "Product",
      "id": "50",
      "attributes": {
        "active": 1,
        "name": "Amazon Attribution",
        "summary": "",
        "is_storage_product": 0,
        "created_at": "2019-03-29T09:00:00",
        "modified_at": "2019-03-29T09:00:00",
        "required_meta_fields": [
          "remote_identity_id",
          "profile_id"
        ]
      },
      "relationships": {
        "remote_identity_type": {
          "data": {
            "type": "RemoteIdentityType",
            "id": "14"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 4,
      "count": 79
    }
  }
}

Get Product

Returns a single product by ID.

GET https://subscriptions.api.openbridge.io/product/{product_id}

Example response:

{
  "type": "Product",
  "id": "50",
  "attributes": {
    "active": 1,
    "name": "Amazon Attribution",
    "summary": "",
    "is_storage_product": 0,
    "created_at": "2019-03-29T09:00:00",
    "modified_at": "2019-03-29T09:00:00",
    "required_meta_fields": [
      "remote_identity_id",
      "profile_id"
    ]
  },
  "relationships": {
    "remote_identity_type": {
      "data": {
        "type": "RemoteIdentityType",
        "id": "14"
      }
    }
  }
}

Get Product Payload Definitions

Returns the payload definitions for a product. Each record includes a stage_id used in the stage_ids subscription meta attribute and in History API requests. Applies to source products only.

Note: Filter to payload records with stage_id >= 1000 for current integrations — filter with stage_id__gte=1000:

GET https://service.api.openbridge.io/service/products/product/{product_id}/payloads?stage_id__gte=1000

Example response:

{
  "links": {
    "first": "/product/81/payloads?page=1",
    "last": "/product/81/payloads?page=1",
    "next": "",
    "prev": ""
  },
  "data": [
    {
      "type": "Product",
      "id": "2180",
      "attributes": {
        "name": "amzn_attribution_advertisers",
        "created_at": "2024-05-07T10:27:51.059000-05:00",
        "modified_at": "2024-05-07T10:27:51.092000-05:00",
        "stage_id": 1000
      }
    },
    {
      "type": "Product",
      "id": "2181",
      "attributes": {
        "name": "amzn_attribution_metrics",
        "created_at": "2024-05-07T10:27:51.228000-05:00",
        "modified_at": "2024-05-07T10:27:51.260000-05:00",
        "stage_id": 1001
      }
    },
    {
      "type": "Product",
      "id": "2182",
      "attributes": {
        "name": "amzn_attribution_publishers",
        "created_at": "2024-05-07T10:27:51.411000-05:00",
        "modified_at": "2024-05-07T10:27:51.448000-05:00",
        "stage_id": 1002
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 12
    }
  }
}

Field Reference

Product Fields (GET /product)

Field Type Description
id string Product ID. Use as the product value when creating a subscription.
name string Display name of the product
active integer Whether the product is currently active
summary string Short description of the product
is_storage_product integer 1 if this is a storage destination product; 0 if it is a source product
required_meta_fields array List of subscription_product_meta_attributes keys required for this product
created_at datetime When the product was created
modified_at datetime When the product was last updated
remote_identity_type relationship The remote identity type required by this product, or null if no remote identity is needed

Payload Definition Fields (GET /service/products/product/{id}/payloads)

Field Type Description
id string Payload record ID (not used directly in API calls)
name string Internal pipeline table name for this payload
stage_id integer Stage identifier used in stage_ids subscription meta and History API requests. Values >= 1000 are current; 0 indicates a legacy record.
created_at datetime When the payload record was created
modified_at datetime When the payload record was last updated