Incentivio

Incentivio Recommendation Report Controller API

The recommendation-report-controller API from Incentivio — 4 operation(s) for recommendation-report-controller.

GitHub OpenAPI

Operations 4

GET /incentivio-reports/clients/{clientId}/recommendation-dashboard/top-items #
GET /incentivio-reports/clients/{clientId}/recommendation-dashboard/summary #
GET /incentivio-reports/clients/{clientId}/recommendation-dashboard/average-basket-value #
GET /incentivio-ordering-service/adminitem/image #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/authentication/incentivio-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/openapi/incentivio-recommendation-report-controller-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/conventions/incentivio-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/errors/incentivio-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/data-model/incentivio-data-model.yml
🔗
WellKnown
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/well-known/incentivio-well-known.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/incentivio-recommendation-report-controller-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

incentivio-recommendation-report-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Recommendation Report Controller API
  version: v0
servers:
- url: https://adminapi.incentivio.com/incentivio-admin-api
  description: Generated server url
tags:
- name: recommendation-report-controller
paths:
  /incentivio-reports/clients/{clientId}/recommendation-dashboard/top-items:
    get:
      tags:
      - recommendation-report-controller
      operationId: getTopRecommendedItemsReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopRecommendedItemsDTO'
  /incentivio-reports/clients/{clientId}/recommendation-dashboard/summary:
    get:
      tags:
      - recommendation-report-controller
      operationId: getRecommendationSummary
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RecommendationSummaryDTO'
  /incentivio-reports/clients/{clientId}/recommendation-dashboard/average-basket-value:
    get:
      tags:
      - recommendation-report-controller
      operationId: getAverageBasketValueReport
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: storeIds
        in: query
        required: false
        schema:
          type: array
          default:
          - '*'
          items:
            type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecommendedAverageBasketValueDTO'
  /incentivio-ordering-service/adminitem/image:
    get:
      tags:
      - recommendation-report-controller
      operationId: getItemImagesByDisplayTitles
      parameters:
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
          default: '*'
      - name: itemDisplayTitles
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopRecommendedItemsDTO'
components:
  schemas:
    RecommendedAverageBasketValueDTO:
      type: object
      properties:
        date:
          type: integer
          format: int64
        txWithNoRecommendationsPresented:
          type: number
          format: float
        txWithRecommendationsPurchased:
          type: number
          format: float
        txWithRecommendationsPresentedButNotPurchased:
          type: number
          format: float
    RecommendationSummaryDTO:
      type: object
      properties:
        percentageOfTxWithDisplayedRecommendation:
          type: number
          format: float
        txWithPurchasedRecommendation:
          $ref: '#/components/schemas/MonthlyTileData'
        percentageOfTxWherePurchasedRecommendation:
          type: number
          format: float
        percentageOfRevenueLiftForTxWithPurchasedRecommendation:
          type: number
          format: float
        revenueAddedThroughRecommendations:
          $ref: '#/components/schemas/MonthlyTileData'
        revenueAddedAfterShowingRecommendations:
          $ref: '#/components/schemas/MonthlyTileData'
    MonthlyTileData:
      type: object
      properties:
        total:
          type: integer
          format: int32
        comparedToPreviousMonthPercentage:
          type: number
          format: float
    TopRecommendedItemsDTO:
      type: object
      properties:
        itemName:
          type: string
        qty:
          type: integer
          format: int32
        orders:
          type: integer
          format: int32
        revenue:
          type: number
          format: float
        takeRate:
          type: number
          format: float
        imageUrl:
          type: string