Depict Events API
The Events API from Depict — 3 operation(s) for events.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/depict:depict-events-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Depict Events API
version: '1.0'
tags:
- name: Events
paths:
/create-events:
post:
tags:
- Events
summary: Create Events
operationId: create_events_create_events_post
parameters:
- name: referer
in: header
required: false
schema:
type: string
title: Referer
- name: user-agent
in: header
required: false
schema:
type: string
title: User-Agent
- name: x-forwarded-for
in: header
required: false
schema:
type: string
title: X-Forwarded-For
- name: x-forwarded-host
in: header
required: false
schema:
type: string
title: X-Forwarded-Host
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Event'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/track:
post:
tags:
- Events
summary: Track V2
operationId: track_v2_v2_track_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrackV2Request'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
/v2/create-events:
post:
tags:
- Events
summary: Create Events V2
operationId: create_events_v2_v2_create_events_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrackV2Request'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
Event:
properties:
tenant:
type: string
title: Tenant
market:
type: string
title: Market
deduplication_id:
anyOf:
- type: string
- type: 'null'
title: Deduplication Id
type:
$ref: '#/components/schemas/EEventType'
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
session_id:
anyOf:
- type: string
- type: 'null'
title: Session Id
dsid:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Dsid
ab_test_group:
anyOf:
- type: string
- type: 'null'
title: Ab Test Group
product_id:
anyOf:
- type: string
- type: 'null'
title: Product Id
variant_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Variant Ids
entity_identifiers:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Entity Identifiers
url:
anyOf:
- type: string
- type: 'null'
title: Url
entity_price:
anyOf:
- type: string
- type: 'null'
title: Entity Price
currency:
anyOf:
- type: string
- type: 'null'
title: Currency
document_referrer:
anyOf:
- type: string
- type: 'null'
title: Document Referrer
document_width:
anyOf:
- type: string
- type: 'null'
title: Document Width
attribution_id:
anyOf:
- type: string
- type: 'null'
title: Attribution Id
recommendation_id:
anyOf:
- type: string
- type: 'null'
title: Recommendation Id
search_result_id:
anyOf:
- type: string
- type: 'null'
title: Search Result Id
product_listing_result_id:
anyOf:
- type: string
- type: 'null'
title: Product Listing Result Id
click_location:
anyOf:
- type: string
- type: 'null'
title: Click Location
page_url:
anyOf:
- type: string
- type: 'null'
title: Page Url
recommendation_type:
anyOf:
- type: string
- type: 'null'
title: Recommendation Type
collection_handle:
anyOf:
- type: string
- type: 'null'
title: Collection Handle
shopify_collection_id:
anyOf:
- type: string
- type: 'null'
title: Shopify Collection Id
grid_item_id:
anyOf:
- type: integer
- type: 'null'
title: Grid Item Id
grid_item_link:
anyOf:
- type: string
- type: 'null'
title: Grid Item Link
depict_ab_variant:
anyOf:
- type: string
- type: 'null'
title: Depict Ab Variant
type: object
required:
- tenant
- market
- type
title: Event
UserTransactionMappingEvent:
properties:
user_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: User Id
session_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Session Id
dsid:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Dsid
transaction_id:
type: string
minLength: 1
title: Transaction Id
event_type:
anyOf:
- type: string
const: transaction_mapping
- type: 'null'
title: Event Type
type: object
required:
- transaction_id
title: UserTransactionMappingEvent
PurchasedProduct:
properties:
sku:
type: string
minLength: 1
title: Sku
price:
type: number
minimum: 0.0
title: Price
quantity:
type: integer
minimum: 1.0
title: Quantity
type: object
required:
- sku
- price
- quantity
title: PurchasedProduct
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
EEventType:
type: string
enum:
- page_view
- click
- add_to_cart
- purchase
- element_visible
- ws_click
- recommendations_inserted
- native_shopify_collection_click
- native_shopify_collection_view
- native_shopify_grid_item_click
- shopify_search_item_click
- shopify_search_add_to_cart
- shopify_search_purchase
title: EEventType
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
ProductUnavailableEvent:
properties:
user_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: User Id
session_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Session Id
dsid:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Dsid
event_type:
type: string
const: product_unavailable
title: Event Type
product_id:
type: string
minLength: 1
title: Product Id
unavailability_type:
$ref: '#/components/schemas/EUnavailabilityType'
type: object
required:
- event_type
- product_id
- unavailability_type
title: ProductUnavailableEvent
PurchaseEvent:
properties:
user_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: User Id
session_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Session Id
dsid:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Dsid
transaction_id:
type: string
minLength: 1
title: Transaction Id
event_type:
anyOf:
- type: string
const: purchase
- type: 'null'
title: Event Type
currency:
type: string
title: Currency
products:
items:
$ref: '#/components/schemas/PurchasedProduct'
type: array
minItems: 1
title: Products
depict_ab_variant:
anyOf:
- type: string
- type: 'null'
title: Depict Ab Variant
type: object
required:
- transaction_id
- currency
- products
title: PurchaseEvent
TrackV2Request:
properties:
tenant:
type: string
minLength: 1
title: Tenant
market:
type: string
minLength: 1
title: Market
events:
items:
anyOf:
- $ref: '#/components/schemas/UserTransactionMappingEvent'
- $ref: '#/components/schemas/PurchaseEvent'
- $ref: '#/components/schemas/ProductUnavailableEvent'
type: array
title: Events
type: object
required:
- tenant
- market
- events
title: TrackV2Request
EUnavailabilityType:
type: string
enum:
- out_of_stock
- missing
title: EUnavailabilityType
x-provenance:
method: harvested
publisher: Depict
source: https://api.depict.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)