Appearance
Core Area
BETA
Agent Gateway is in BETA, and we're continuing to expand its capabilities. Your feedback helps shape what we build next—reach out to us through Relewise Support.
Core provides the shared Dataset context and consumption information that connected tools need to work effectively. It is always allowed and available through both the REST API and MCP.
Its metadata capabilities describe the structure and available values of a Dataset. Its consumption summaries report the service usage used to calculate consumption for a Dataset.
Dataset Details
Dataset details identify the requested Dataset and its License and show the effective Agent Gateway access settings for the authenticated user.
Use the REST endpoint:
http
GET /api/v1/datasets/{Dataset ID}/core/datasetFor MCP, use the get_dataset_details tool.
The response includes:
- The Dataset ID, display name, environment type, and server URL.
- The License ID and display name. A License can contain multiple Datasets.
- Whether the REST API and MCP are enabled and the Agent Gateway Areas available for the Dataset.
Use Dataset details after selecting a Dataset from the Identity endpoint and before making other Dataset-scoped requests. Unlike the Identity response, Dataset details are produced from the effective authorization context for the requested Dataset.
Dataset Metadata
Dataset metadata describes the languages and currencies used by the Dataset. A request can also include metadata for Products, Variants, Product Categories, Brands, Content, Content Categories, Users, and Companies.
Use the REST endpoint:
http
GET /api/v1/datasets/{Dataset ID}/core/dataset/metadataFor MCP, use the get_dataset_metadata tool.
The request requires an inclusive fromDate and toDate. Optional metadata groups are excluded unless requested.
Use Dataset metadata before other Agent Gateway capabilities when you do not know the Dataset's valid languages, currencies, Data Keys, Classification Values, or other entity metadata. Discover Dataset-specific values instead of guessing them. Data Key names are case-sensitive.
Consumption Summaries
Consumption summaries show service usage for a Dataset through aggregate measurements and daily time series. Each summary covers one Relewise service for a requested period and its preceding equivalent comparison period, and is available through an individual REST endpoint and MCP tool.
| Summary | REST Endpoint | MCP Tool |
|---|---|---|
| Behavioral Tracking | /core/consumption/behavioral-tracking/summary | fetch_behavioral_tracking_consumption_summary |
| Integrations | /core/consumption/integrations/summary | fetch_integrations_consumption_summary |
| Recommendations | /core/consumption/recommendations/summary | fetch_recommendations_consumption_summary |
| Shoppertainment and Adaptive Discovery | /core/consumption/shoppertainment/summary | fetch_shoppertainment_consumption_summary |
| Search | /core/consumption/search/summary | fetch_search_consumption_summary |
| Analyzer | /core/consumption/analyzer/summary | fetch_analyzer_consumption_summary |
| Marketing Automation | /core/consumption/marketing-automation/summary | fetch_marketing_automation_consumption_summary |
| Retail Media | /core/consumption/retail-media/summary | fetch_retail_media_consumption_summary |
| Content Delivery | /core/consumption/content-delivery/summary | fetch_content_delivery_consumption_summary |
REST endpoint paths in the table are relative to:
text
https://my.relewise.com/agents/api/v1/datasets/{Dataset ID}Each REST endpoint accepts the following required query parameters:
| Parameter | Description |
|---|---|
fromDate | Inclusive first date of the requested period, formatted as YYYY-MM-DD. |
toDate | Inclusive last date of the requested period, formatted as YYYY-MM-DD. |
MCP tools accept equivalent fromDate and toDate inputs.
Summary Response
Every consumption summary uses the same response model:
fromDateandtoDateidentify the inclusive requested period.comparisonFromDateandcomparisonToDateidentify the preceding period of equal length.metricscontains the available named metrics. An empty summary returns an empty collection.- Each metric contains one or more named
measurements. - Each measurement includes a display-ready value and a numeric value suitable for calculations.
- When comparison data is available, a measurement also includes the previous display-ready and numeric values, the arithmetic change, and the relative percentage change.
- Comparison values are
nullwhen comparison data is unavailable or a relative change cannot be calculated. graphcontains the available daily time series for the requested period.- Each series has a display name and chronological data points containing a date and numeric value.
- Data points represent dates for which analytics data is available. Dates without available data may be omitted, so the returned dates are not necessarily continuous or identical to the requested period.
Access Requirements
The Agent Gateway configuration must enable the connection method you use. Core is always allowed and cannot be deselected.
REST requests and MCP connections require a valid Personal Access Token whose Dataset Scope includes the requested Dataset. See Get Started with Agent Gateway for connection and authentication instructions.