> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomarketbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The signed-in supplier’s Week & demand view

> Booked, searched and unfilled demand by hour of week over the supplier’s area, with their bookable hours, a glance and suggestions — the same view the MarketBox dashboard shows them. Hours are the supplier’s home zone, derived per instant from the rollup’s UTC buckets. Counts of 1–2 read "few"; fewer than 20 bookings in the window is `not_enough_data` with no grid. Requires the API key and the supplier’s user token. 403 `INSIGHTS_DISABLED` when the project’s Week & demand switch is off.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/suppliers/me/demand
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/suppliers/me/demand:
    get:
      tags:
        - Supplier plane
      summary: The signed-in supplier’s Week & demand view
      description: >-
        Booked, searched and unfilled demand by hour of week over the supplier’s
        area, with their bookable hours, a glance and suggestions — the same
        view the MarketBox dashboard shows them. Hours are the supplier’s home
        zone, derived per instant from the rollup’s UTC buckets. Counts of 1–2
        read "few"; fewer than 20 bookings in the window is `not_enough_data`
        with no grid. Requires the API key and the supplier’s user token. 403
        `INSIGHTS_DISABLED` when the project’s Week & demand switch is off.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              The project (tenant) that owns the resource. Every resource in
              this API is scoped to a project, and your API key is restricted to
              the projects it was issued for — a project outside that scope
              returns 403.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: >-
            The project (tenant) that owns the resource. Every resource in this
            API is scoped to a project, and your API key is restricted to the
            projects it was issued for — a project outside that scope returns
            403.
          name: projectId
          in: path
        - schema:
            type: string
            enum:
              - zone
              - wider
            default: zone
            description: Your travel zone, or the zone plus a 15-minute drive
          required: false
          description: Your travel zone, or the zone plus a 15-minute drive
          name: area
          in: query
        - schema:
            type: string
            enum:
              - '30'
              - '90'
              - '180'
            default: '30'
            description: The trailing window, in whole UTC days ending today
          required: false
          description: The trailing window, in whole UTC days ending today
          name: days
          in: query
      responses:
        '200':
          description: The demand view
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      state:
                        type: string
                        enum:
                          - ok
                          - not_enough_data
                          - no_area
                      window:
                        type: object
                        properties:
                          days:
                            anyOf:
                              - type: number
                                enum:
                                  - 30
                              - type: number
                                enum:
                                  - 90
                              - type: number
                                enum:
                                  - 180
                          fromUtcDate:
                            type: string
                          toUtcDate:
                            type: string
                          area:
                            type: string
                            enum:
                              - zone
                              - wider
                          zone:
                            type: string
                            minLength: 1
                          weekStart:
                            type: string
                        required:
                          - days
                          - fromUtcDate
                          - toUtcDate
                          - area
                          - zone
                          - weekStart
                        additionalProperties: false
                      zoneLabel:
                        type: string
                        minLength: 1
                      area:
                        type: object
                        properties:
                          source:
                            type: string
                            enum:
                              - travel_zone
                              - locations
                              - none
                            description: >-
                              travel_zone: the schedules travel-zone cells;
                              locations: 30/45-minute drive circles around fixed
                              locations; none: no_area
                          cells:
                            type: integer
                            minimum: 0
                          complete:
                            type: boolean
                          label:
                            type: string
                            minLength: 1
                        required:
                          - source
                          - cells
                          - complete
                          - label
                        additionalProperties: false
                      grid:
                        type: object
                        nullable: true
                        properties:
                          booked:
                            type: array
                            items:
                              type: array
                              items:
                                type: object
                                properties:
                                  level:
                                    type: integer
                                    minimum: 0
                                    maximum: 5
                                  count:
                                    anyOf:
                                      - type: integer
                                        minimum: 0
                                      - type: string
                                        enum:
                                          - few
                                required:
                                  - level
                                  - count
                                additionalProperties: false
                            description: '[day MON…SUN][hour 6 AM…9 PM] in window.zone'
                          searched:
                            type: array
                            items:
                              type: array
                              items:
                                type: object
                                properties:
                                  level:
                                    type: integer
                                    minimum: 0
                                    maximum: 5
                                  count:
                                    anyOf:
                                      - type: integer
                                        minimum: 0
                                      - type: string
                                        enum:
                                          - few
                                required:
                                  - level
                                  - count
                                additionalProperties: false
                            description: '[day MON…SUN][hour 6 AM…9 PM] in window.zone'
                          unfilled:
                            type: array
                            items:
                              type: array
                              items:
                                type: object
                                properties:
                                  level:
                                    type: integer
                                    minimum: 0
                                    maximum: 5
                                  count:
                                    anyOf:
                                      - type: integer
                                        minimum: 0
                                      - type: string
                                        enum:
                                          - few
                                required:
                                  - level
                                  - count
                                additionalProperties: false
                            description: '[day MON…SUN][hour 6 AM…9 PM] in window.zone'
                        required:
                          - booked
                          - searched
                          - unfilled
                        additionalProperties: false
                      bookableMask:
                        type: array
                        items:
                          type: array
                          items:
                            type: boolean
                      glance:
                        type: object
                        nullable: true
                        properties:
                          bookableHours:
                            type: number
                            minimum: 0
                          busyBookableHours:
                            type: number
                            minimum: 0
                          busyNotBookableHours:
                            type: number
                            minimum: 0
                          ranges:
                            type: array
                            items:
                              type: object
                              properties:
                                day:
                                  type: string
                                  enum:
                                    - MON
                                    - TUE
                                    - WED
                                    - THU
                                    - FRI
                                    - SAT
                                    - SUN
                                start:
                                  type: string
                                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                  description: Local wall clock, HH:MM, in window.zone
                                end:
                                  type: string
                                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                  description: Local wall clock, HH:MM, in window.zone
                                bookable:
                                  type: boolean
                                level:
                                  type: integer
                                  minimum: 1
                                  maximum: 5
                              required:
                                - day
                                - start
                                - end
                                - bookable
                                - level
                              additionalProperties: false
                        required:
                          - bookableHours
                          - busyBookableHours
                          - busyNotBookableHours
                          - ranges
                        additionalProperties: false
                      suggestions:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                key:
                                  type: string
                                  pattern: >-
                                    ^(open|quiet):(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\d|2[0-3]):[0-5]\d-([01]\d|2[0-3]):[0-5]\d$
                                day:
                                  type: string
                                  enum:
                                    - MON
                                    - TUE
                                    - WED
                                    - THU
                                    - FRI
                                    - SAT
                                    - SUN
                                start:
                                  type: string
                                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                  description: Local wall clock, HH:MM, in window.zone
                                end:
                                  type: string
                                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                  description: Exclusive end, HH:MM local
                                booked:
                                  type: integer
                                  minimum: 0
                                kind:
                                  type: string
                                  enum:
                                    - open
                                unfilled:
                                  type: integer
                                  minimum: 0
                                prefill:
                                  type: object
                                  properties:
                                    weeklyTimeRanges:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          dayOfWeek:
                                            type: string
                                            enum:
                                              - MO
                                              - TU
                                              - WE
                                              - TH
                                              - FR
                                              - SA
                                              - SU
                                            description: >-
                                              The weekday this range falls on, in the
                                              row’s zone.
                                            example: MO
                                          startTime:
                                            type: string
                                            pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                            description: >-
                                              Wall-clock start, HH:MM in the row’s
                                              zone.
                                            example: '09:00'
                                          endTime:
                                            type: string
                                            pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                            description: >-
                                              Wall-clock end, HH:MM in the row’s zone;
                                              must differ from startTime.
                                            example: '17:00'
                                          crossesMidnight:
                                            type: boolean
                                            description: >-
                                              True exactly when endTime is earlier
                                              than startTime (the range ends next
                                              day).
                                            example: false
                                          sortOrder:
                                            type: integer
                                            minimum: 0
                                            description: >-
                                              Display order among the ranges of one
                                              day, from 0.
                                            example: 0
                                        required:
                                          - dayOfWeek
                                          - startTime
                                          - endTime
                                          - crossesMidnight
                                          - sortOrder
                                      minItems: 1
                                  required:
                                    - weeklyTimeRanges
                                  additionalProperties: false
                              required:
                                - key
                                - day
                                - start
                                - end
                                - booked
                                - kind
                                - unfilled
                                - prefill
                              additionalProperties: false
                            - type: object
                              properties:
                                key:
                                  type: string
                                  pattern: >-
                                    ^(open|quiet):(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\d|2[0-3]):[0-5]\d-([01]\d|2[0-3]):[0-5]\d$
                                day:
                                  type: string
                                  enum:
                                    - MON
                                    - TUE
                                    - WED
                                    - THU
                                    - FRI
                                    - SAT
                                    - SUN
                                start:
                                  type: string
                                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                  description: Local wall clock, HH:MM, in window.zone
                                end:
                                  type: string
                                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                  description: Exclusive end, HH:MM local
                                booked:
                                  type: integer
                                  minimum: 0
                                kind:
                                  type: string
                                  enum:
                                    - quiet
                                scheduleId:
                                  type: string
                                  minLength: 1
                              required:
                                - key
                                - day
                                - start
                                - end
                                - booked
                                - kind
                                - scheduleId
                              additionalProperties: false
                      asOf:
                        type: string
                        nullable: true
                        format: date-time
                      complete:
                        type: boolean
                    required:
                      - state
                      - window
                      - zoneLabel
                      - area
                      - grid
                      - bookableMask
                      - glance
                      - suggestions
                      - asOf
                      - complete
                    additionalProperties: false
                required:
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Missing or invalid API key or user token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: >-
            The API key cannot access this project (FORBIDDEN) or lacks standard
            API access (CAPABILITY_NOT_GRANTED); or the signed-in user has no
            MarketBox account record (FORBIDDEN, "User account not found.
            Complete registration first."); or the signed-in user is not a
            member of the project (NOT_A_MEMBER), their membership has ended
            (MEMBERSHIP_INACTIVE), or the roles they act under lack the route’s
            permission (NO_SUPPLIER_ROLE); or X-MB-Acting-Role names a role they
            do not hold (ACTING_ROLE_NOT_HELD); or INSIGHTS_DISABLED (the
            project turned the feature off)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: >-
            The signed-in user has no supplier record here: no SUPPLIER among
            the roles they act under (NO_SUPPLIER_ROLE), or no single supplier
            record linked to them (SUPPLIER_NOT_LINKED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - ApiKeyAuth: []
          EndUserBearer: []
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.
    EndUserBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The signed-in person's Cognito access token, issued to this
        application's app client. Sent with the API key on the /clients/me and
        /suppliers/me routes.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.