Incentivio

Incentivio Guest Journey Controller API

The guest-journey-controller API from Incentivio — 6 operation(s) for guest-journey-controller.

GitHub OpenAPI

Operations 6

GET /incentivio-guest-journey-service/user/{userId}/journey #
GET /incentivio-guest-journey-service/guestsummary #
GET /incentivio-guest-journey-service/guestrevenuesummary #
GET /incentivio-guest-journey-service/guestcountsummary #
GET /incentivio-guest-journey-service/clients/{clientid}/merchants/{merchantid}/guestrevenuesummarybystore #
GET /incentivio-guest-journey-service/clients/{clientid}/merchants/{merchantid}/guestcountsummarybystore #

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-guest-journey-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-guest-journey-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-guest-journey-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Guest Journey Controller API
  version: v0
servers:
- url: https://adminapi.incentivio.com/incentivio-admin-api
  description: Generated server url
tags:
- name: guest-journey-controller
paths:
  /incentivio-guest-journey-service/user/{userId}/journey:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestJourney
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ViewGuestJourneyResponse'
  /incentivio-guest-journey-service/guestsummary:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestSummary
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestSummaryResponse'
  /incentivio-guest-journey-service/guestrevenuesummary:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestRevenueSummary
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestRevenueSummaryResponse'
  /incentivio-guest-journey-service/guestcountsummary:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestCountSummary
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestCountSummaryResponse'
  /incentivio-guest-journey-service/clients/{clientid}/merchants/{merchantid}/guestrevenuesummarybystore:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestRevenueSummaryByStore
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      - name: guesttype
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/GuestSegmentType'
      - name: stores
        in: query
        required: false
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestRevenueSummaryByStoreResponse'
  /incentivio-guest-journey-service/clients/{clientid}/merchants/{merchantid}/guestcountsummarybystore:
    get:
      tags:
      - guest-journey-controller
      operationId: viewGuestCountSummaryByStore
      parameters:
      - name: startdate
        in: query
        required: true
        schema:
          type: string
      - name: enddate
        in: query
        required: true
        schema:
          type: string
      - name: guesttype
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/GuestSegmentType'
      - name: stores
        in: query
        required: false
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestCountSummaryByStoreResponse'
components:
  schemas:
    GuestSummaryResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/GuestSegmentInfo'
    GuestSegmentType:
      type: string
      enum:
      - STRANGER
      - ROOKIE
      - REGULAR
      - LOYALIST
      - CHAMPION
      - WHALE
      - SLIDER
      - CHURNED
    GuestSegmentRecoveryInfo:
      type: object
      properties:
        recoveredCount:
          type: integer
          format: int64
        recoveredAnnualSpend:
          type: number
          format: double
    GuestCountSummary:
      type: object
      properties:
        clientId:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        date:
          type: string
        guestCount:
          type: integer
          format: int64
    GuestRevenueSummaryByStoreResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestRevenueSummaryByStore'
    GuestRevenueSummaryByStore:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        storeId:
          type: string
        storeName:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        date:
          type: string
        revenuePercentage:
          type: number
          format: double
    GuestJourneyStatus:
      type: object
      properties:
        jobId:
          type: integer
          format: int32
        status:
          type: string
        modifiedDate:
          type: string
    PagingDTO:
      type: object
      properties:
        total:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
        currentPage:
          type: integer
          format: int32
    GuestSegmentOfferInfo:
      type: object
      properties:
        offerTypeCount:
          type: integer
          format: int32
        distributionCount:
          type: integer
          format: int32
        redemptionPercentage:
          type: number
          format: double
    GuestSegmentTrend:
      type: string
      enum:
      - UPTREND
      - DOWNTREND
      - STAGNANT
    GuestCountSummaryByStoreResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestCountSummaryByStore'
    GuestCountSummaryResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestCountSummary'
    GuestRevenueSummaryResponse:
      type: object
      properties:
        summary:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/GuestRevenueSummary'
    ViewGuestJourneyResponse:
      type: object
      properties:
        journey:
          type: array
          items:
            $ref: '#/components/schemas/GuestJourneyStatus'
        paging:
          $ref: '#/components/schemas/PagingDTO'
    GuestSegmentInfo:
      type: object
      properties:
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        guestCount:
          type: integer
          format: int64
        annualSpend:
          type: number
          format: double
        annualSpendPerUser:
          type: number
          format: double
        annualSpendPerUserTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        averageCheckSize:
          type: number
          format: double
        averageCheckSizeTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        revenuePercentage:
          type: number
          format: double
        revenuePercentageTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        guestPercentage:
          type: number
          format: double
        guestPercentageTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        visitsPerMonth:
          type: number
          format: double
        visitsPerMonthTrend:
          $ref: '#/components/schemas/GuestSegmentTrend'
        recoveryInfo:
          $ref: '#/components/schemas/GuestSegmentRecoveryInfo'
        offerInfo:
          $ref: '#/components/schemas/GuestSegmentOfferInfo'
        updatedDate:
          type: string
          format: date-time
    GuestRevenueSummary:
      type: object
      properties:
        clientId:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        revenuePercentage:
          type: number
          format: double
        date:
          type: string
    GuestCountSummaryByStore:
      type: object
      properties:
        clientId:
          type: string
        merchantId:
          type: string
        storeId:
          type: string
        storeName:
          type: string
        segmentType:
          $ref: '#/components/schemas/GuestSegmentType'
        date:
          type: string
        guestCount:
          type: integer
          format: int64