Cineamo API
Schemas
AdvertisementBreakdown
CIN-14671 / CIN-14697 — one campaign's impressions, clicks and purchase intents split by platform,
device and placement.
A composite result rather than an `AbstractCountDto` subclass (see the analytics note in
`service/api/CLAUDE.md`): it carries three independent breakdowns plus the campaign totals, which
none of the count/average/revenue base shapes model.
Every rate on this DTO is nullable and null means "nothing to divide by" — never 0%. A card that
renders a null as 0% states that a platform was shown the ad and nobody clicked, which is a
different (and unsupported) claim.
totalsThe campaign's exact lifetime impressions and clicks, read from the counters on the advertisement itself rather than recomputed from the event rows. No purchase-intent figure: the campaign's own is carried by the advertisement list's metricPurchaseIntentCount embed, and two independently cached answers to one question end up disagreeing on screen.
object[]
Impressions, clicks and purchase intents per platform (client). Every known platform is present even at zero, plus an unknown bucket for rows that carry no platform, so the split always adds up to the total.
object[]
Impressions, clicks and purchase intents per device type, same shape and same unknown bucket as platform.
object[]
Per placement. The impressions and clicks come from the exact per-placement counters on the advertisement; the purchase intents have no counter and are grouped from the ad clicks they are attributed to (ADR 0016). An unsplit row appears only when the campaign has a remainder from before placements were counted separately — including a remainder of intents alone.
AdvertisementCinemaRow
CIN-14671 — one cinema's row in a campaign's By Cinema table.
cinemaIdNull for events that are not attributed to a cinema — a platform-wide placement legitimately has none. The row is kept so the table adds up to the campaign's total.
cinemaNamecityimpressionsclicksctrclicks / impressions for this cinema. Null when the cinema has no impressions — which happens for a cinema that only has clicks recorded.
mobileShareShare of this cinema's device-carrying impressions, 0..1. Null when none of its impressions carry a device type.
tabletSharedesktopShareMovieAdCampaignsRow
CIN-14682 — one film's row on the Movie Campaigns index.
Carries no poster or localised title: the admin table already resolves those per movie through the
movie endpoint, and duplicating them here would give the same screen two sources for one label.
movieIdNumeric Movie Id — the canonical film reference.
Example: 4242
movieTitleThe film's original title, for sorting and as a fallback label.
distributorNamesEvery distributor that holds a copyright behind these campaigns. More than one is possible: a film can carry several copyrights.
campaignCountcinemaCountDistinct cinemas that accepted any of these campaigns — counted once across the film, not summed per campaign.
Example: 26
impressionsclicksclickRateclicks / impressions across the film's campaigns. Null when there are no impressions yet — not 0.
Example: 0.014
statusesEvery status present among the film's campaigns, so the row can show one chip per state.
AdClick
variantAdVariant id this click is attributed to (A/B testing). Must belong to the addressed advertisement.
Example: 1
idreferrerPagereadOnly
clientipAddressdeviceTypeuidAdImpression
variantAdVariant id this impression is attributed to (A/B testing). Must belong to the addressed advertisement.
Example: 1
idreferrerPagereadOnly
clientipAddressdeviceTypeuidAdVariant
idlabelclickThroughUrltopBannerImageReftopBannerImageUrltopBannerDesktopImageReftopBannerDesktopImageUrllayerImageReflayerImageUrlimpressionCountclickCountctrweightisActiveisWinnerWhether this variant is the campaign's current A/B winner (highest CTR among variants with enough impressions).
Example: false
Advertisement
idreadOnly
adCategoryadvertiserNameadvertiserImageRefadvertiserImageUrltenantIdsstartDatetimeendDatetimecinemaIdsclickThroughUrltopBannerImageReftopBannerImageUrltopBannerDesktopImageReftopBannerDesktopImageUrllayerImageReflayerImageUrlplacementimpressionCountimpressionCountTopBannerimpressionCountLayerimpressionThresholdclickCountclickCountTopBannerclickCountLayercostPer1kImpressionsmaxBudgetdailyMaxBudgetdailyImpressionThresholdimpressionCountTodaystatusdisplayLocationsmetricCinemasTotalCountmetricCinemasDeclinedCountmetricCinemasAcceptedCountmetricPurchaseIntentCountAdVariant[] · readOnly
AdvertisementMinimum
idreadOnly
adCategoryadvertiserNameadvertiserImageUrlvariantIdstartDatetimeendDatetimeclickThroughUrltopBannerImageReftopBannerImageUrltopBannerDesktopImageReftopBannerDesktopImageUrllayerImageReflayerImageUrlplacementstatusdisplayLocationsAgeRating
idcountryCodetyperatingAgendaSlice
idorderdurationtitlecateringCinApi\CinemaRoom\Dto\CinemaRoomDtoInterface | null · readOnly
readOnly
CinemasCatchment
Unlike its neighbours this DTO does not extend AbstractCountDto: the endpoint does not answer with
a single figure but with a composite of several figures plus an optional nested city collection,
and the abstract count DTO has no shape to carry that.
radiusKmThe radius the figures were computed for.
Example: 20
cinemaCountCinemas that contributed — they exist, are not deleted and have coordinates.
Example: 412
cinemaWithoutLocationCountRequested cinemas that could not contribute, e.g. because they have no coordinates.
Example: 3
cityCountDistinct cities inside the radius of at least one contributing cinema. A city covered by several cinemas counts once.
Example: 1840
populationSummed population of those cities. This is the population of city points from the SimpleMaps import, not a population grid and not a travel-time catchment — label it as "people living in cities within the radius", not as a catchment area.
Example: 31000000
populationKnownCityCountHow many of the counted cities carry a population figure at all, so consumers can tell a complete sum from a partial one.
Example: 1802
array | null · readOnly
Covered city points, only present when withCities was requested. Capped — check isCityListTruncated; the aggregate figures above stay exact either way.
isCityListTruncatedTrue when more cities were covered than cities carries points for.
Example: false
MovieShowingsByCinema
A movie's run across the network: the aggregate figures, plus the per-cinema breakdown they are folded out of.
movieIdThe movie the figures describe, echoed back.
Example: 8391
cinemaCountCinemas with at least one qualifying showing — the length of cinemas.
Example: 700
showingCountQualifying showings across all of those cinemas — the sum over cinemas.
Example: 12400
firstShowingDatetimeEarliest qualifying showing start. Null when nothing qualified — the movie never ran in the network, or not inside the requested window. When a window was requested this is the first showing inside it, not the movie's first day in the network, so a window anchored on the run's own start has to be derived from an unwindowed response.
Example: 2021-12-15T14:00:00Z
lastShowingDatetimeLatest qualifying showing start, null under the same conditions as firstShowingDatetime.
Example: 2022-04-03T20:30:00Z
object[] · readOnly
The complete per-cinema breakdown, ordered by cinema id. Deliberately not HAL-paginated, and deliberately without a cap or a truncation flag: this is an analytics aggregate rather than a resource collection, a consumer needs all of it to derive a scope from it at all, and the array is bounded by the network's own cinema count — the list the consumer already holds. CinemasCatchment.cities set that precedent, and unlike city points this set cannot outgrow its bound. Cinemas the movie never played in are absent rather than present with a zero count.
AssetDeleteResultDto
DTO representing the result of a delete operation.
pathPath of the deleted asset
typeType of the deleted asset (file or directory)
deletedCountNumber of items deleted
AssetDirectoryResultDto
DTO representing the result of a directory creation operation.
pathFull path of the created directory
nameName of the created directory
createdList of created directory paths
AssetDownloadUrlDto
DTO representing a download URL for an asset.
pathPath of the asset
urlPre-signed download URL
AssetItemDto
DTO representing a single asset item (file or directory).
nameName of the asset
pathFull path of the asset
typeType of the asset (file or directory)
sizeSize of the asset in bytes
lastModifiedLast modification timestamp
urlPublic URL of the asset
AssetListDto
DTO representing a paginated list of assets.
List of asset items
pathCurrent path being listed
nextTokenToken for fetching the next page of results
AssetRenameResultDto
DTO representing the result of a rename operation.
oldPathOriginal path of the asset
newPathNew path of the asset
typeType of the renamed asset (file or directory)
BankAccount
idibanbicbankNameaccountOwnerisSepaMandatBuddyGroup
idnameslugdescriptionprofileImageRefprofileImageUrlbackgroundImageRefbackgroundImageUrlcreatorIdBuddyGroupInvitation
expireDatetimeidbuddyGroupIdissuerIdCinApi\User\Dto\UserDtoInterface | null · readOnly
acceptedDatetimedeclinedDatetimeBusinessEventRequest
idrequesterNamespecialRequirementsisShowMoviebudgetOverallbudgetCateringisExclusiveUsageadditionalInformation
Cart
uuidCinApi\User\Dto\UserDtoInterface | null · readOnly
clientcreatedDatetimepriceNetSum of the CartItem prices (Product netPrice * quantity), before taxes
Example: 100
priceTotalActual amount the customer will pay (subtotal + taxes)
Example: 100
amountDueAmount the customer will pay after gift card deductions
Example: 1080
PriceAdjustment[] · readOnly
Full price breakdown with all adjustments
onlineTicketingFeepaidDatetimecinemaIdorderIdwithinTenantReachWhether the cart's cinema is reachable in the calling app (CIN-14421): false when it belongs to another brand's chain, so the app must not resume this checkout. True for platform callers, chain matches and cinema-less carts; null when the endpoint does not compute it.
Example: true
isPaidPriceAdjustment
typeAdjustment type: subtotal, tax, fee, discount, total, gift_card, amount_due
Example: tax
labelHuman-readable label for this adjustment
Example: VAT 19%
amountAmount in cents. Negative for deductions (discounts, gift cards)
Example: 380
CartItem
idproductIdquantitycinemaIdcreatedDatetimeCinApi\Product\Dto\ProductDtoInterface | null
ChainCustomContent
idcinemaChainIdnamedescriptiondescriptionEnposterImageRefposterImageUrlResolved CDN url for the posterImageRef; null when no image is set.
backdropImageRefbackdropImageUrlResolved CDN url for the backdropImageRef; null when no image is set.
trailerUrlageRatingdurationdefaultInheritWhen true, creating this resource pushes INHERITED to every cinema in the chain.
Example: true
positionChainCustomContentAssignment
idnull for synthesized PENDING rows; integer for stored assignments.
chainCustomContentIdcinemaIdstatusEnum values:
INHERITED
OVERRIDDEN
NOT_INHERITED
PENDING
overrideValuesmixed>
effectiveValuesmixed>
ChainMovieCustomization
idcinemaChainIdmovieIdnameDisplay/search label (derived from the movie title at create time).
Example: The Dark Knight
titledescriptionposterImageRefposterImageUrlResolved CDN url for the posterImageRef; null when no image is set.
backdropImageRefbackdropImageUrlResolved CDN url for the backdropImageRef; null when no image is set.
preferedTrailerUrlisActivedefaultInheritWhen true, creating this resource pushes INHERITED to every cinema in the chain.
Example: true
positionChainMovieCustomizationAssignment
idnull for synthesized PENDING rows; integer for stored assignments.
chainMovieCustomizationIdcinemaIdstatusEnum values:
INHERITED
OVERRIDDEN
NOT_INHERITED
PENDING
overrideValuesmixed>
effectiveValuesmixed>
ChainSpecialTag
idcinemaChainIdnamecolordescriptionimageRefimageUrlResolved CDN url for the imageRef; null when no image is set.
defaultInheritWhen true, creating this resource pushes INHERITED to every cinema in the chain.
Example: true
positionChainSpecialTagAssignment
idnull for synthesized PENDING rows; integer for stored assignments.
chainSpecialTagIdcinemaIdstatusEnum values:
INHERITED
OVERRIDDEN
NOT_INHERITED
PENDING
overrideValuesmixed>
effectiveValuesmixed>
CineStarLoyaltyBalance
The user's current CineStar point balance.
Nullable because `balance` appears in no required list upstream: null means CineStar
did not report a balance, which is not the same as a balance of zero, and a client
should render the two differently.
balanceCurrent loyalty point balance, or null if not reported
Example: 42.5
CineStarLoyalty
The user's CineStar loyalty membership, as their Customer API reports it.
Both fields are required upstream, so both are non-nullable here. Nothing is added:
points, tier and expiry do not exist in the contract, and inventing them in a DTO is
how a UI ends up built on fields the partner never sends.
cardNumberCineStar loyalty card number
Example: W000000002118662
membershipIdCineStar membership id
Example: CSCNVDPXQ8Y8L
Cinema
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
Example: https://cdn.example.com/cinema-logo-image/00000000-0000-0000-0000-000000000000
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdreadOnly
showtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramsEnum values:
cinfinity
cineville
Example: ["cinfinity"]
linkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
Example: 6
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
Example: 1120
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
Example: 5
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
Example: Europe/Berlin
homepageThe cinema's own website. Null when none is recorded.
Example: https://www.cinema-xyz.de/
hasMarketingAssistantBookedCinemaContent
cinemaIdidnameslugcategorydescriptiondescriptionEnisOwnContentdurationcreatorCinemaIdposterImageRefposterImageUrlbackdropImageRefbackdropImageUrlageRatingtrailerUrlhasMarketingAssistantBookedfutureShowingsCountpremiereDatemovieIdisRegularEventreadOnly · deprecated
readOnly · deprecated
CinemaMovie
idoriginalTitlecinemaIdtmdbIdtitlelastUpdatedisTmdbSyncSkippedseriesselectedByCinemaadultbackdropPatharray | null · readOnly
homepageimdbIdoriginalLanguageoverviewpopularityposterPatharray | null · readOnly
productionCountriesreleaseDaterevenueruntimefirstAirDatestatustaglinevideovoteAveragevoteCountreadOnly
readOnly
readOnly
readOnly
readOnly
readOnly
noRightsAvailablenoRightsTimestampreadOnly
slugrentrakTitlereadOnly
cineamoIdCinemaAdvertisement
cinemaIdadvertisementIdisDeclinedmatchesCinemaShowingsCinemaBlog
idtitlecontenthashtagsreadOnly · required
positionisDraftactiveFromDatetimeactiveUntilDatetimeCinemaCard
idurlnamepositiontypeshowCardTitletextbuttonTextimageRefimageUrlimageDescriptionactiveFromDatetimeactiveUntilDatetimeisDraftCinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly
CinemaChain
idnamedescriptionlogoUrllogoImageRefimageUrlimageRefprimaryColorslugphoneemailyouthProtectionOfficerstreetpostalCodecitystatecountryfacebookLinkinstagramLinktiktokLinkyoutubeLinklinkedinLinkxingLinkbrandImageUrlThe chain's brand mark for a square or round slot: the chain logo, else the chain image.
Mirrors a cinema's brandImageUrl, so a chain-scoped notification campaign can show the
icon its push notifications will carry.
Example: https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000
CinemaChainEmployee
idcinemaChainIduserIdemailfirstNamelastNameimageUrlisActivatedrolesobject[]
isChainAdmincoversAllCinemasTrue when this user effectively covers every cinema in the chain — either via a CinemaChainEmployeeRelation (chain admin) or by being a CinemaEmployeeRelation member of every cinema in the chain. The UI uses this to render an "All cinemas" chip in place of the individual cinema list.
Address
streetpostalCodecitystatestateCodecountrycountryCodeCinemaCompany
idlegalNamedisplayNameregistrationNumbercontactEmailinvoiceEmailphoneNumbertaxIdstatuscreatedDatetimereadOnly
hasPayoutConfighasAdsPayoutConfigCinemaConfiguration
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringticketSystemticketSystemIdticketUrlTemplatefacebookAccessTokenhasMarketingAssistantBookedvisitorThreshold1visitorThreshold2isProgramSuggestionEnabledisPrivateBookingEnabledisActiveisOnlineTicketingEnabledonlineTicketingisKOSCustomerisInterestSystemActivatedisGiftCardRedemptionEnabledisWebsiteCustomerwebsiteConfigurationticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixdomainpulseTenantIdsubscriptionProgramsEnum values:
cinfinity
cineville
Example: ["cinfinity"]
isPublicRequestAvailableisPrivateBookingPartnerisOnlineTicketingAvailableCinemaConfigurationSecure
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringticketSystemticketSystemIdticketUrlTemplatefacebookAccessTokenhasMarketingAssistantBookedvisitorThreshold1visitorThreshold2isProgramSuggestionEnabledisPrivateBookingEnabledisActiveisOnlineTicketingEnabledonlineTicketingisKOSCustomerisInterestSystemActivatedisGiftCardRedemptionEnabledisWebsiteCustomerwebsiteConfigurationticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixdomainpulseTenantIdsubscriptionProgramsEnum values:
cinfinity
cineville
Example: ["cinfinity"]
showtimesAdapterConfigurationisPublicRequestAvailableisPrivateBookingPartnerisOnlineTicketingAvailableCinemaContentUpcoming
idcreatedDatetimereadOnly
readOnly
releaseDatepositionCinemaDistinction
idcreatedDatetimereadOnly
readOnly
positionCinemaFaq
idquestionanswercinemaIdpositionCinemaFeaturedContent
idcreatedDatetimereadOnly
readOnly
highlightTextdesktopImageRefmobileImageRefactiveFromDatetimeactiveUntilDatetimeshowFeatureBadgefeatureBadgeshowButtonbuttonTitlereasonhighlightColorlinkpositionCinemaLink
idurlnamepositiontypeCinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly
CinemaMovieRecommendation
idreadOnly · required
readOnly
createdDatetimeCinemaOpeningHour
iddayOfWeekstartMinutelengthalternateEndDescriptionCinemaPartner
idnamepositionaddresstypelongitudelatitudedistanceToCinema(in meters)
Example: 123
logoImageReflogoImageUrlimageRefimageUrlcinemaIdlinklogoBackgroundColorCinemaPartnerBenefit
iddescriptioncinemaPartnerIdimageRefimageUrlCinemaPayout
idcinemaCompanyIdcinemaCompanyLegalNamecreditNoteNumberperiodStartperiodEndstatepayoutTypeEnum values:
tickets
advertising
Example: tickets
subtotalNettaxAmountPayoutTaxGroup[] · readOnly
VAT breakdown over ALL line items, one entry per occurring rate, ascending by rate.
totalGrosscineamoFeeNetcashbackNetstripeFeeNetticketSystemFeeNetnetMarginpdfPathsentDatetimepaidDatetimesepaExportedDatetimecreatedDatetimeCinemaPayoutLineItem
iddescriptionseatCategoryNamepriceDiscountNamebasePriceGrossquantityamountNettaxtaxAmountamountGrossisRefundpositioncinemaIdmovieTitledistributorNameimpressionCountcampaignStartcampaignEndcostPer1kImpressionssharePercentagePayoutLiabilityCompanyEntry
cinemaCompanyIdcinemaCompanyLegalNameliabilityCentsTotal outstanding payout liability (tickets + advertising), in net cents.
Example: 1500000
outstandingItemsticketLiabilityCentsOutstanding ticket liability (base ticket price), net cents.
Example: 1200000
adsLiabilityCentsOutstanding advertising revenue share liability (net cents).
Example: 300000
liabilityGrossCentsTotal outstanding payout liability (tickets + advertising), in gross cents (incl. VAT).
Example: 1605000
ticketLiabilityGrossCentsOutstanding ticket liability (base ticket price), gross cents (incl. 7% VAT).
Example: 1284000
adsLiabilityGrossCentsOutstanding advertising revenue share liability (gross cents, incl. 19% VAT).
Example: 321000
PayoutLiability
totalCentsPayoutLiabilityCompanyEntry[] · readOnly
totalGrossCentsTotal outstanding payout liability across all companies, gross cents (incl. VAT).
Example: 5063240
PayoutOrderItem
idorderIdcartItemIdproductIdproductSnapshotamountamountNetquantitycreatedDatetimePayoutTaxGroup
rateVAT rate in percent (7 for tickets, 19 for advertising and concessions).
Example: 7
netAmountSum of all line item net amounts at this rate, in cents.
Example: 10000
taxAmountSum of all line item tax amounts at this rate, in cents.
Example: 700
PendingPayout
cinemaCompanyIdcinemaCompanyLegalNamepayoutConfigIdintervalpayoutTypeEnum values:
tickets
advertising
Example: tickets
suggestedPeriodStartsuggestedPeriodEnddaysOverduePositive = overdue, 0 = period ends today, negative = upcoming
Example: 18
lastPayoutIdlastPayoutCreditNoteNumberlastPayoutPeriodEndexistingPayoutIdSet when a non-finalized payout (draft/approved/sent) already covers the suggested period. The frontend must link here instead of offering a duplicate "Create" action.
Example: 12
existingPayoutCreditNoteNumberexistingPayoutStateEnum values:
draft
approved
sent
Example: draft
CinemaPayoutConfig
idcinemaCompanyIdcinemaCompanyLegalNameintervaladsIntervalobject[] · readOnly
object[] · readOnly
bankAccountIdbankAccountIbanisActivesettledThroughcreatedDatetimemodifiedDatetimeCinemaProductCategory
idCinema · required
nameCinemaPromotion
iddesktopImageRefdesktopImageUrlmobileImageRefmobileImageUrlimageDescriptionlinkvideoLinkactiveFromDatetimeactiveUntilDatetimepositioncinemaIdCinemaRoom
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefCinemaRoomShape
widthdepthheightidScreen
widthheightsizeis3DReadyisImaxresolutionidCinemaShowtimesImport
idcinemaIdcinemaSiteIdstartDatetimeendDatetimestatusEnum values:
queued
in_progress
finished
failed
partially_failed
Example: completed
successCountfailureCountunmatchedMovieCounttotalCountticketSystemsinitiatorIdinitiatorUsernameCinemaSite
idnamedescriptionstreetpostalCodecitystatestateAbbrphonelatitudelongitudeprofileImageRefcinemaIdcreatedDatetimeCinemaSiteConfiguration
idcinemaSiteIdticketSystemticketSystemIdticketUrlTemplateticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixshowtimesAdapterConfigurationcreatedDatetimeupdatedDatetimeCity
idnamenameAsciinameAltnameLocalnameLocalLangISO 639 language code for the local name
Example: lit
countryiso31662iso31663latitudelongitudeadminNamepopulationtimezonedistanceDistance in meters from the reference point (only present when filtering by location)
Example: 1234.56
Content
idnameslugcategorydescriptiondescriptionEnisOwnContentdurationcreatorCinemaIdposterImageRefposterImageUrlbackdropImageRefbackdropImageUrlageRatingtrailerUrlhasMarketingAssistantBookedfutureShowingsCountpremiereDatemovieIdisRegularEventreadOnly · deprecated
readOnly · deprecated
ContentMetrics
messagesCountNumber of recommendation messages sent by MarketingAssistant
clickedMessagesCountNumber of clicked recommendation messages sent by MarketingAssistant
ticketPurchaseIntentsCountNumber of ticket purchase intents caused by MarketingAssistant recommendation messages
CopyrightConditionPrivateRule
idmaximumPersonCountrent
CopyrightConditionPrivateRuleDefault
idmaximumPersonCountrentrequired
CopyrightConditionPublic
idminimumRentalshareOfTicketminimumTicketFee
CopyrightConditionPublicDefault
idminimumRentalshareOfTicketminimumTicketFee
CorsOrigin
idorigincategoryEnum values:
movie_landing_page
dedicated_cinema_website
partner
Example: partner
commentisActivecreatedBycreatedDatetimemodifiedDatetimeCrawlResult
idcrawlRunIdcinemaIdadapterIdstatuscrawlerSourceIdshowtimeCountrawCountskippedCountdurationMserrorMessageskippedReasonscreatedDatetimeCrawlRun
idrunIdstatusstartedAtfinishedAtsourceCountsuccessCountfailureCounttotalShowtimeCountdurationMstriggerTypeinitiatorIderrorSummarycreatedDatetimemodifiedDatetimeCrawlerSource
idcinemaIdcinemaNamecinemaSiteIdcinemaSiteNameadapterIdsourceUrlsourceConfigisEnabledtimezonelocalecreatedDatetimemodifiedDatetimeDeal
idtitlesubtitledescriptionslugcategorybenefitTypebenefitAmountCents. Fixed price or amount off, depending on benefitType.
Example: 750
benefitPercentbuyCountpayCountbenefitNoteisPermanentDerived, read-only: true when no validity rule carries a dateFrom or dateTo, so the deal is not bounded in time. A weekday or time-of-day rule leaves a deal permanent, and a deal with no validity rules at all is permanent. Send validity rules without dates to make a deal permanent -- this is not an input.
Example: true
isDraftimageUrlcreatedDatetimemodifiedDatetimereadOnly
readOnly
readOnly
object[]
object[]
channelsshowingTagIdsmovieIdsobject[]
DealOperator
The deal as its own cinema's staff (and admins) see it (CIN-14499 review #5).
All three GET routes are public, and one DTO served every audience, so an anonymous caller received
the operator's own working data: how many times each deal had been redeemed, its cap, its ordering
position, and the whole notification-campaign schedule. Redemption counts are commercially
sensitive; the rest is noise a public consumer has no use for.
The split is drawn from what consumers actually read, checked across every frontend rather than
assumed -- which is why two fields the review wanted moved are still on the public DealDto:
- `qrCode` is the guest's voucher. apps/web renders it for the logged-in user (DealSidebar ->
DealQrCodeModal), and a consumer is not an employee of the cinema, so moving it here would
delete that feature.
- `isDraft` is always false for a public caller -- the list forces the filter and the read route
404s a draft -- so it leaks nothing, and apps/web's own `deal.isDraft` guard on the detail page
stays meaningful instead of silently reading undefined.
Extends DealDto with a variadic forward, the shape MovieDateSecureDto uses, so the ~25 shared
fields are declared once.
idtitlesubtitledescriptionslugcategorybenefitTypebenefitAmountCents. Fixed price or amount off, depending on benefitType.
Example: 750
benefitPercentbuyCountpayCountbenefitNoteisPermanentDerived, read-only: true when no validity rule carries a dateFrom or dateTo, so the deal is not bounded in time. A weekday or time-of-day rule leaves a deal permanent, and a deal with no validity rules at all is permanent. Send validity rules without dates to make a deal permanent -- this is not an input.
Example: true
isDraftimageUrlcreatedDatetimemodifiedDatetimereadOnly
readOnly
readOnly
object[]
object[]
channelsshowingTagIdsmovieIdsobject[]
positionredemptionLimitredeemedCountisNotificationEnabledisScheduledNotificationEnablednotificationScheduledFornotificationSentAtDisabledTmdbImage
idfilePathcreatedBycreatedDatetimemodifiedDatetimeDistinction
idnamedescriptionimageRefimageUrlDistributorAdvertisementDto
idreadOnly
adCategoryadvertiserNameadvertiserImageRefadvertiserImageUrltenantIdsstartDatetimeendDatetimecinemaIdsclickThroughUrltopBannerImageReftopBannerImageUrltopBannerDesktopImageReftopBannerDesktopImageUrllayerImageReflayerImageUrlplacementimpressionCountimpressionCountTopBannerimpressionCountLayerimpressionThresholdclickCountclickCountTopBannerclickCountLayercostPer1kImpressionsmaxBudgetdailyMaxBudgetdailyImpressionThresholdimpressionCountTodaystatusdisplayLocationsmetricCinemasTotalCountmetricCinemasDeclinedCountmetricCinemasAcceptedCountmetricPurchaseIntentCountAdVariant[] · readOnly
DistributorAdvertisement
cinemaIdadvertisementIdisDeclinedmatchesCinemaShowingsDistributor
idnameslugemaildescriptionphonestreetpostalCodecityisActiveisEnabledDefaultConditionsdefaultConditionsAlternativeTextimageUrlimageRefcountryCodeDistributorMovieStatistics
showingAllCountshowingDECountshowingCHCountshowingATCountcinemaAllCountcinemaDECountcinemaCHCountcinemaATCountnotificationAllCountpurchaseIntentAllCountviewMoviePageAllCountNotificationUserAgeRange
r0_9r10_19r20_29r30_39r40_49r50_64r65_100rNullEquipment
idnamecountcountAvailableisCountEnabledCinemaMinimum · required
EventRequestDetails
idticketSystemIdCinApi\User\Dto\UserDtoInterface | null
nameslughospitalitycreatedDatetimeEventRequest
idUser · required
Cinema · required
nameslugdescriptionisPrivatecategoryisRegularShowtimeisCreatedByCinemastateticketSystemIdhospitalitydurationexpirationDatetimeuniqueIdcommentCinemacommentInitiatoronlineTicketUrlinitialCommentimageUrlpriceCinData\Entity\CinemaRoom | null · readOnly
facebookIdcreatedDatetimelastNotificationSentfinalDatetimeacceptedByCinemaDatetimefinalAcceptedTimestampfinalDeclinedTimestamppersonCountcountVisitorisCinemaMarketingisCorporationdeclineReasonisFavoriteticketPriceisOriginalVoiceisThreeDimensionalageRatingEventRequestDate
idpriorityisPendingisAcceptedByCinemadatetimeEventRequestLike
idvisitDatetimeisLikedCinApi\User\Dto\UserDtoInterface | null · readOnly
readOnly
EventRequestNote
idUser · required
textcreatedDatetimemodifiedDatetimeEventRequestSettings
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringvisitorThreshold1visitorThreshold2isPublicRequestAvailableFirm
idfirmNamephonestreetNumberpostalCodecitypositionFlyer
idcinemaIdflyerTemplateIdnamestartDateendDatedocumentcreatedAtupdatedAtversionFlyerTemplate
idcinemaIdnamedocumentcreatedAtupdatedAtversionFlyerVersion
idflyerIdcreatedAtdocumentNull in list responses on purpose — twenty documents in one payload is waste, and the list only ever renders timestamps. The single-version endpoint fills it, so a version can be inspected before it is restored.
Genre
idnametmdbIdGeoLocation
longitudelatitudecountryregioncitypostalCodeGiftCard
idgiftCardTypeIdcodeticketSystemIdcreatedDatetimeGiftCardType
idticketSystemIdnameminimumLoadAmountmaximumLoadAmountincrementStepimageRefcreatedDatetimeIdentity
idtenantIdsourceTypeanonymousIdconsentStatususerIdmergedIntoIdfirstSeenAtlastSeenAtImage
idpathimageRefimageUrlpositionimageDescriptionInvoice
idcartUuidThe owning cart's uuid. Also fills the cartUuid placeholder of the invoice route, so the
self-link points at the real cart instead of a hardcoded nil uuid (CIN-13864).
Example: b35f2d0b-c489-45ed-83de-e58448e16b4c
readOnly
createdDatetimecurrencylocaleticketSystemIdpaymentMethodcardWalletTypeBaseMessage
id
typeeventNamecontextpathsymboltitletextdataendpointcreatedDatetimeadapterimagescheduledDatetimeMessage
User · required
readOnly
isReadisReceivedClientisClickedisDeletedcreatedDatetime
typeeventNamecontextpathsymboltitletextdataendpointadapterimageUrlsecondaryImageUrlThe sender's brand mark (CIN-11261) — the SAME url the push carried in its icon/logo slot,
so the system notification and this inbox row show one logo. Clients render it as the row
thumbnail and fall back to imageUrl, then to their own placeholder, when it is null
(platform-wide or multi-cinema senders, or a cinema with neither a logo nor a profile
image). Distinct from imageUrl, which stays the big picture / artwork.
Example: https://cdn.cineamo.com/cinema-logo-image/3f2504e0-4f89-11d3-9a0c-0305e82c3301
scheduledDatetimemovieIdProductionCompany
nameidlogoPathoriginCountryMoviePilot
voteAveragelinkvoteCountMovieContent
idnameslugcategorydescriptiondescriptionEnisOwnContentdurationcreatorCinemaIdposterImageRefposterImageUrlbackdropImageRefbackdropImageUrlageRatingtrailerUrlhasMarketingAssistantBookedfutureShowingsCountpremiereDatemovieIdisRegularEventreadOnly · deprecated
readOnly · deprecated
Movie
idoriginalTitletmdbIdtitlelastUpdatedisTmdbSyncSkippedseriesselectedByCinemaadultbackdropPatharray | null · readOnly
homepageimdbIdoriginalLanguageoverviewpopularityposterPatharray | null · readOnly
productionCountriesreleaseDaterevenueruntimefirstAirDatestatustaglinevideovoteAveragevoteCountreadOnly
readOnly
readOnly
readOnly
readOnly
readOnly
noRightsAvailablenoRightsTimestampreadOnly
slugrentrakTitlereadOnly
cineamoIdMovieMinimumDto
lastUpdatedseriesadultpopularityvoteAveragevoteCountreadOnly · required
readOnly · required
idtmdbIdtitlebackdropPatharray | null · readOnly
imdbIdoriginalTitleoriginalLanguageoverviewposterPathreleaseDatereadOnly
runtimefirstAirDatestatustaglinereadOnly
slugcineamoIdMovieTmdbImage
One TMDB artwork image of a movie, as seen by the admin app (CIN-14129) —
including images that are globally disabled and therefore stripped from all
public movie responses.
filePathisDisableddisabledTmdbImageIdId of the blocklist row (DELETE /disabled-tmdb-images/{id} re-enables the image); null when the image is not disabled
Example: 7
isPrimaryTrue when this file is the effective primary of its locale group (CIN-14159): the admin-chosen primary when set and enabled, otherwise the highest-rated enabled image — the pick the serving logic falls back to. Backdrop groups without their own choice are served by the language-less resolution, so only the 'xx' group carries the fallback badge there. Disabled images never carry the flag.
Example: false
isPrimaryOverrideTrue when isPrimary comes from an admin-chosen primary rather than the TMDB default
Example: false
widthheightaspectRatioiso6391iso31661ISO 3166-1 country of the image's locale, when TMDB tags one (e.g. de-CH artwork)
Example: CH
voteAveragevoteCountisCustomUploadTrue for the movie's uploaded custom image (CIN-14159): filePath holds its "upload:
Example: false
assetUrlCDN URL of the uploaded custom image; null for TMDB images
primaryForLocaleKeysThe locale keys whose primary the ADMIN has pointed at this image (isPrimaryOverride mirrors "non-empty"). Empty when no admin pick references it. A pick applies only to the locales listed here — the same image may be the pick for en-GB and not for en-US.
defaultForLocaleKeysThe locale keys this image is the AUTOMATIC pick for — the highest-rated enabled image of a group with no admin choice, i.e. what serving falls back to. Disjoint from primaryForLocaleKeys: a locale has either an admin pick or an automatic one, never both.
MovieTmdbImages
Complete TMDB artwork inventory of a movie for the admin app (CIN-14129),
built from the raw tmdbdata JSON without the disabled-image filter, so the
admin can re-enable blocked images.
movieIdMovieTmdbImage[] · readOnly
MovieTmdbImage[] · readOnly
MovieTmdbImage[] · readOnly
MovieLocalized
V2 locale-aware movie detail DTO.
title, overview, and tagline are resolved from TMDB translation data for the
requested locale (Accept-Language). All other fields are identical to V1.
idtmdbIdtitleoriginalTitleoriginalLanguageoverviewtaglinelocaleseriesadultbackdropPathposterPathslugimdbIdpopularityvoteAveragevoteCountruntimereleaseDatestatusarray | null · readOnly
array | null · readOnly
productionCountrieslastUpdatedfirstAirDatebudgetrevenuehomepagenoRightsAvailablenoRightsTimestamprentrakTitleisTmdbSyncSkippedreadOnly
readOnly
readOnly
array | null · readOnly
readOnly
readOnly
readOnly
TMDB release dates with Cineamo-curated age ratings overlaid; a country present in both has its TMDB entries replaced by the custom ones.
readOnly
readOnly
preferedTrailerUrlCustom trailer URL from cinema customization
isCustomizedTrue when an active cinema customization was applied
cinemaIdPresent only when X-Cinema-Id header is provided
overridePosterImageRefAdmin global poster-override asset ref (CIN-14124).
overrideBackdropImageRefAdmin global backdrop-override asset ref (CIN-14124).
overrideLogoImageRefUploaded custom logo asset ref (CIN-14159).
isPosterHiddenTrue when the poster is hidden by an admin override (CIN-14124).
isBackdropHiddenTrue when the backdrop is hidden by an admin override (CIN-14124).
isLogoHiddenTrue when the logo is hidden by an admin override (CIN-14436).
cineamoIdMovieLocalizedList
V2 locale-aware movie list item DTO.
A trimmed-down version of MovieLocalizedDto used when returning movies
in a paginated collection. title, overview, and tagline are resolved from
TMDB translation data for the requested locale (Accept-Language).
idtmdbIdtitleoriginalTitleoriginalLanguageoverviewtaglinelocaleseriesadultbackdropPathposterPathslugimdbIdpopularityvoteAveragevoteCountruntimereleaseDatestatusarray | null · readOnly
lastUpdatedfirstAirDatereadOnly
TMDB release dates with Cineamo-curated age ratings overlaid; a country present in both has its TMDB entries replaced by the custom ones.
readOnly
readOnly
readOnly
preferedTrailerUrlCustom trailer URL from cinema customization
isCustomizedTrue when an active cinema customization was applied
cinemaIdPresent only when X-Cinema-Id header is provided
ratingAverageAverage Cineamo user rating (1–10); null when no ratings exist yet
cineamoIdMovieAccessibility
idmovieIdiso31661gretaMovieIdhasClosedCaptionhasAudioDescriptionhasSoundAmplificationMovieAgeRating
idiso31662cineamoMovieIdageRatingIdMovieAlias
idnameisResolvedisFromBackupcreatedDatetimereadOnly
titleticketSystemticketSystemMovieIdmovieIdThe id of the matched movie, or null when the alias has no match.
Example: 155
cineamoMovieIdDeprecated: use movieId instead (the legacy Cineamo movie id). Removed on 2026-10-01.
Example: 155m
MovieConfiguration
idmovieIdlandingPageConfigurationdomainMovieCopyright
idcreatedDatetimeisLicensedeventRequestsCountreadOnly
isCreatedByDistributorinternalDistributorMovieIdstartDatetimeendDatetimereadOnly
sourceMovieCustomization
idcreatedDatetimereadOnly
readOnly
titledescriptionposterImageRefposterImageUrlbackdropImageRefbackdropImageUrliso6393ISO 639-3 language code
Example: deu
preferedTrailerUrlCustom trailer URL
Example: https://example.com/trailer.mp4
isActiveMovieDate
idnamebuddyGroupIdCinApi\User\Dto\UserDtoInterface | null · readOnly
isMultiSelectAllowedstateDerived from timestamps and the related showings. "expired" is set when the MovieDate is published, has at least one option, but every option's showing is in the past.
Enum values:
draft
voting
voting_scheduled
decided
expired
Example: draft
selectedOptionIdcreatedDatetimeisPublicMovieDateSecure
idnamebuddyGroupIdCinApi\User\Dto\UserDtoInterface | null · readOnly
isMultiSelectAllowedstateDerived from timestamps and the related showings. "expired" is set when the MovieDate is published, has at least one option, but every option's showing is in the past.
Enum values:
draft
voting
voting_scheduled
decided
expired
Example: draft
selectedOptionIdcreatedDatetimeisPublictokenMovieDateToken
idnamebuddyGroupIdCinApi\User\Dto\UserDtoInterface | null · readOnly
isMultiSelectAllowedstateDerived from timestamps and the related showings. "expired" is set when the MovieDate is published, has at least one option, but every option's showing is in the past.
Enum values:
draft
voting
voting_scheduled
decided
expired
Example: draft
selectedOptionIdcreatedDatetimeisPublictokenMovieDateOption
iddatetimeshowingIdcinemaIdmovieDateIdcineamoIdMovieDateVote
idmovieDateIdoptionIdvoterIdvoterNamevoterEmailisPublicCinApi\User\Dto\UserDtoInterface | null · readOnly
MovieRating
idratingisSpoilerTrue when the review reveals plot details. Consumers can hide these by default.
Example: false
movieIdCinApi\User\Dto\UserDtoInterface | null · readOnly
headlinetextcreatedDatetimecinemaExperienceScoreHow well the movie performed on a big cinema screen (1–10).
Example: 7
MovieRatingMe
ratingisSpoilerTrue when the review reveals plot details. Consumers can hide these by default.
Example: false
idcineamoMovieIdmovieIdCinApi\User\Dto\UserDtoInterface | null · readOnly
headlinetextcinemaExperienceScoreHow well the movie performed on a big cinema screen (1–10).
Example: 7
MovieTour
idtitledescriptionmovieIdstartDatetimeendDatetimeMovieTourStop
idmovieTourIdpositiongueststartDatetimeendDatetimeshowingIdbookingUrlcinemaIdplaceNamecityIdaddressiso31661MovieTrailer
idmovieIdtitleurlyoutubeVideoIdyoutubeChannelIdyoutubeThumbnailthumbnaillanguageproviderIdpublishedviewsimdbIdtmdbIdcategoriesMovieVersion
idmovieIdrentrakReleaseCodeMain identifier for box office tracking and analytics
Example: 123456
rentrakPublicReleaseCodeIdentifier for public/commercial screenings
Example: 123457
rentrakBookingReleaseCodeIdentifier used by distributors for booking and scheduling
Example: 123458
rentrakGermanReleaseCodeSpecific identifier for the German market
Example: 123459
videoVideo/Projection format
Enum values:
DEFAULT
DIGITAL
PLF
DBOX
DIGIMAX
IMAX_3D
3D
IMAX
Example: IMAX_3D
audioAudio/Language format
Enum values:
DEFAULT
SUBTITLED
ORIGINAL
DUBBED
SP
RECORDED
LIVE
Example: SUBTITLED
CinApi\Movie\V1\Dto\MovieDtoInterface | null · readOnly
createdDatetimemodifiedDatetimeNewsletterCampaign
idcinemaIdtypestatussubjectpreviewTextcontentendingContenthasProgramOverviewButtonsectionsSnapshottargetTypetargetReferenceIdtotalRecipientstotalDeliveredtotalOpenedtotalClickedtotalBouncedscheduledAtsentAtcreatedAtNewsletterSendLog
idcampaignIdsubscriberIdstatusresendMessageIdsentAtdeliveredAtopenedAtclickedAtbouncedAtNewsletterConfig
idcinemaIdisEnabledisAutoSendsendDaysendTimedraftLeadHourssenderNamesenderEmailreplyToEmailisApprovalRequireddefaultLanguageEnum values:
automatic
deu
eng
Example: automatic
cinemaWeekStartDaycinemaWeekEndDaywelcomeTextDewelcomeTextEnendingTextDeendingTextEnNewsletterSection
idconfigIdcinemaIdtypepositioncustomContentNewsletterSubscriber
idcinemaIdemailfirstNamelastNamelocaledoiStatusdoiConfirmedAtunsubscribedAtcreatedAtobject[] · readOnly
NewsletterSubscriberTag
idcinemaIdnamecolorcreatedAtNewsletterSubscription
idsubscriberIdtypereferenceIdNotificationCampaign
Admin/cinema view of an authored notification campaign (the {@see \CinData\Entity\Notification\Notification}),
as returned by the create + send endpoints.
idtitlebodystatusaudiencetransportsEnum values:
push
inbox
email
categorytenantIdimageUrlsecondaryImageUrlscheduledDatetimecreatedDatetimerecipientCountRecipients (users) this campaign was sent to.
deliveredCountRecipients (users) actually reached on at least one device, inbox or email. recipientCount - deliveredCount is the number who received nothing, which is what the partially_failed status reflects.
failedCountIndividual DEVICE pushes that failed — a delivery-health diagnostic, not a recipient count. It may exceed recipientCount (users can have several devices) and may be non-zero on a fully delivered campaign (one dead device among several), so it is not comparable with the two counts above.
NotificationCampaignTarget
The entity a campaign deep-links to (CIN-14296), as returned on the campaign.
Deliberately id-only: every value here comes off the campaign row itself (a lazy proxy's identifier
needs no query), so the shared list endpoint stays free of an N+1 lookup it would gain nothing
from. Clients resolve the title/artwork from the id with the query they already need for the picker.
typeEnum values:
movie
cinema
showing
deal
idisMissingTrue when the linked entity was deleted (the FK was nulled) — the campaign itself is intact.
NotificationChannel
A single entry of the notification-channel registry (the per-brand push / white-label apps).
Exposes just what the campaign-authoring UI needs to render the channel selector — the stable
`key` (stored in a campaign's audience) and the human-readable `name`.
keynameNotificationDelivery
Consumer inbox item, backed by {@see \CinData\Entity\Notification\NotificationDelivery} (design §3.3).
Mirrors the legacy Message DTO so clients migrate easily, with two differences: {@see $id} is a UUID
(deliveries are UUID-keyed, unlike concrete_message), and {@see $channel} is exposed so the client
knows which app/brand the item belongs to.
User · required
idchannelisReadisReceivedClientisClickedisDeletedcreatedDatetime
typeeventNamecontextpathsymboltitletextdataendpointadapterimageUrlsecondaryImageUrlscheduledDatetimemovieIdtargetTypetargetIdNotificationMetering
One tenant's notification usage over the queried window (design §3.14) — for quota/billing.
tenantIdtenantNamecampaignCountrecipientCountdeliveredCountfailedCountNotificationPreferences
The authenticated user's notification consent for the request's channel (design §7a): their MARKETING
opt-in state plus, per followed cinema, whether that cinema's marketing is muted.
channelmarketingOptedInobject[]
NotificationMessage
idtitlebodyreadOnly
createdDatetimecineamoMovieIdDeprecated: the legacy Cineamo movie id. This endpoint is slated for removal and gains no numeric alternative.
Example: 123m
movieIdDeprecated: despite the name this is the legacy Cineamo movie id, not a numeric movie id. This endpoint is slated for removal.
Example: 123m
OAuthClient
iduserIdnameredirectUrisisRevokedisConfidentialplainSecretPlaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.
Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e
createdAtupdatedAtOrder
idcinemaIduserIdemailpriceNetpriceTotalstatecreatedDatetimeinvoiceIdinvoiceRefcartUuidarray | null · readOnly
Full price breakdown with all adjustments
clientOrderItem
idquantityproductIdamountNetamountorderIdproductSnapshotorderRequest
idemailfirmNamestreetNumbercitypostalCodecontactPersonplanpaymentMethodvouchercreatedDatetimeOrderRequestBankAccount
idreadOnly · required
EG1600100099000010052142810bicbankNameaccountOwnerisSepaMandatOrderRequestCinema
idcinemaNamestreetpostalCodecitycontactPersonreadOnly · required
cinemaRoomCountreadOnly
PriceDiscount
idnamepriceChangeCinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly
PriceFactor
idCinema · required
multiplierisDefaultPriceOption
idnamepriceNetisShowingDefaultCinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly
readOnly
readOnly
priceTotalPrice after applied fees and taxes
Example: 100
AbstractProductDto
idnamepriceTotalpriceNettaxtypeDistributorPulseAdCrossCampaign
CIN-14645 — cross-campaign cohort comparison for two of a distributor's advertisements.
The raw counts ship alongside the ratios on purpose: a CTR pair with no sample sizes invites
over-reading a difference between two handfuls of visitors, so the UI can always show N.
`scopeTenantId`, `scopeSourceType` and the two windows are echoed back rather than left to the docs
because the figures are only meaningful *within* one tenant — a screenshot of the card has to be
self-describing about what it covers.
exposedIdentitiesIdentities with an ad_impression on the exposure ad
Example: 4210
exposedReachExposed identities the measured ad also reached
Example: 2680
exposedClicksExposed identities that clicked the measured ad
Example: 268
exposedCtrexposedClicks / exposedReach. Null when the measured ad reached nobody exposed.
Example: 0.1
carryOverRateexposedClicks / exposedIdentities — of everyone reached by the exposure ad, the share that went on to click the measured ad. Null when the exposure ad reached nobody. NOTE: this is NOT exposedCtr, whose denominator is only the part of the cohort the measured ad reached. Use this one for a "carry-over rate" figure.
Example: 0.0637
controlReachIdentities the measured ad reached that were NOT exposed
Example: 19400
controlClicksNon-exposed identities that clicked the measured ad
Example: 1164
controlCtrcontrolClicks / controlReach. Null when the measured ad reached nobody unexposed.
Example: 0.06
upliftexposedCtr / controlCtr - 1. Null until both cohorts have reach. CORRELATION, NOT CAUSATION: the exposed cohort self-selects (they were online during the first campaign, so they are more active users by construction), and a signed-out visitor who switched device between the two campaigns counts as two identities and lands in the control group — which biases this toward zero.
Example: 0.667
scopeTenantIdThe tenant these figures are scoped to. A Pulse identity never spans tenants, so the cohort only holds inside this one.
Example: f0c1e2d3-a4b5-4c6d-8e7f-091a2b3c4d5e
scopeSourceTypeSource narrowing, when one was requested. Null means every source in the tenant.
Example: platform_web
exposureWindowThe exposure advertisement's own booked window, as used for the query
measuredWindowThe measured advertisement's own booked window, as used for the query
DistributorPulseCompetitor
Market comparison for a distributor's movie vs other active movies.
yourMovieobject[]
marketAveragetotalMoviesTotal number of movies with showings in the period
Example: 100
DistributorPulseMovieShowings
Showing-based analytics for a distributor's movie.
Covers: showings/cinemas metric cards, weekly chart, holdover card, regional chart.
totalShowingstotalCinemascurrentWeekWeek number since release
Example: 5
object[]
holdoverregionalDistributorPulseTopMovie
movieIdcineamoIdCineamo movie ID (slug identifier)
Example: 155m
titleinterestScoreuniqueIdentitiestotalEventsgenresreleaseYearshowtimesCountNumber of showings across all cinemas
Example: 3214
DistributorPulseTotalEvents
Extended total events DTO with per-event-type counts for distributor metric cards.
totalEventspassiveEventsactiveEventstransactionalEventspageViewsCount of page_view events
Example: 1200
purchaseIntentsCount of ticket_purchase_intent events
Example: 180
trailerPlaysCount of trailer_play events
Example: 420
trailerCompletedCount of trailer_play_finished events
Example: 150
ticketPurchasesCount of ticket_purchase events
Example: 120
marketAveragePageViewsMarket average page_view events per movie
Example: 340
marketAverageTrailerPlaysMarket average trailer_play events per movie
Example: 95
marketAveragePurchaseIntentsMarket average ticket_purchase_intent events per movie
Example: 48
marketAverageTicketPurchasesMarket average ticket_purchase events per movie
Example: 30
marketAverageTrailerCompletionRateMarket average trailer completion rate (0–100)
Example: 35
object[]
Per-trailer started/completed breakdown
PulseBestTimeEntry
hourHour of day (0-23)
Example: 18
eventsTotal events in this hour across the period
Example: 420
PulseConversionPerMovie
movieIdtitleviewsNumber of page_view events
Example: 320
purchaseIntentsNumber of ticket_purchase_intent events
Example: 48
conversionRateConversion rate (purchaseIntents / views * 100)
Example: 15
showtimesNumber of showings in the period
Example: 12
PulseConversionRate
cinemaConversionRateCinema conversion rate (transactional/total * 100)
Example: 12.4
platformConversionRatePlatform-wide average conversion rate
Example: 8.7
PulseEngagementFunnel
avgPassiveToActivePlatform avg: active/passive * 100
Example: 51.3
avgActiveToTransactionalPlatform avg: transactional/active * 100
Example: 33.3
avgPassiveToTransactionalPlatform avg: transactional/passive * 100
Example: 17.1
PulseIdentityMergeMatrixEntry
sourceSourceTypeSource type of the identity merged away
Example: website
targetSourceTypeSource type of the surviving identity
Example: platform_web
mergeseventsAffectedPulsePlatformConversionRate
conversionRatePlatform-wide transactional/total * 100
Example: 9.8
previousConversionRatetotalEventstransactionalEventsPulsePlatformEngagementFunnel
passiveEventsactiveEventstransactionalEventsavgPassiveToActiveactive/passive * 100
Example: 46.5
avgActiveToTransactionaltransactional/active * 100
Example: 44.7
avgPassiveToTransactionaltransactional/passive * 100
Example: 20.8
PulsePlatformIdentityMerges
totalMergespreviousTotalMergeseventsAffectedavgEventsPerMergeCross-surface stitching: merges grouped by source/target source type
PulsePlatformIdentityStats
totalIdentitiesanonymousIdentitiesNo user ID and not merged away
Example: 19204
knownIdentitiesIdentities with a known user ID
Example: 4380
mergedIdentitiesIdentities merged into another identity
Example: 1896
newIdentitiesIdentities first seen within the period
Example: 1204
previousNewIdentitiesIdentities first seen within the previous period
Example: 1011
byConsentPulsePlatformOverview
totalEventspreviousTotalEventsuniqueIdentitiespreviousUniqueIdentitiesactiveTenantsTenants of any type that emitted events in the period
Example: 42
activeCinemasCinema/cinema-chain tenants that emitted events in the period
Example: 38
passiveEventsactiveEventstransactionalEventsknownIdentityRatePercentage of unique identities with a known user ID
Example: 18.4
PulsePlatformTimelineBySourceEntry
datewebsiteEvents from cinema websites
Example: 1240
appEvents from cinema apps
Example: 311
platformWebEvents from the Cineamo web platform
Example: 845
platformAppEvents from the Cineamo mobile app
Example: 102
totalPulsePlatformTopMovie
movieIdcineamoIdCineamo movie ID (slug identifier)
Example: 155m
titleinterestScoreuniqueIdentitiestotalEventstenantCountNumber of tenants with interest signal for this movie
Example: 17
genresPulsePlatformTopTenant
tenantIdnameslugtenantTypeentityIdCinema/distributor entity ID for drill-down
Example: 1234
totalEventsuniqueIdentitieswebsiteEventsappEventsplatformWebEventsplatformAppEventsPulseShowingSlot
showingIdtimecinemaRoominterestLevelEnum values:
low
medium
high
very-high
Example: high
interestScorepageViewsclicksOnTimepurchaseIntentsrankPulseShowingTagPerformance
tagIdnametotalEventsuniqueVisitorsconversionsinterestScorePulseTimelineEntry
dateeventsbenchmarkEventsPlatform-wide average events per tenant for this day
Example: 1800
PulseTopMovie
movieIdcineamoIdCineamo movie ID (slug identifier)
Example: 155m
titleinterestScoreuniqueIdentitiestotalEventsgenresPulseTotalEvents
totalEventspreviousTotalEventspassiveEventsactiveEventstransactionalEventsPulseUpcomingDemand
movieIdtitlestartDateDate of the first upcoming showing
Example: 2026-03-20
interestedVisitorsUnique visitors who showed interest
Example: 234
demandLevelDemand level: high, medium or low
Example: high
RoomObject
idroomIdtypenameshapeId
transformId
isDeletedRoomObjectShape
widthdepthheightidRoomObjectTransform
positionXpositionYpositionZrotationXrotationYrotationZidSearchResult
kindEnum values:
movie
custom-content
cinema
city
user
Example: movie
entityIdtitleslugreleaseYearcastNamesgenreNamesTMDB genre names in the Accept-Language language, resolved from the genre ids (tmdbdata stores only the import language). Populated for the movie kind only.
Example: ["Action","Adventure","Science Fiction"]
cityregioncountrystreetStreet and house number; populated for the cinema kind only.
Example: Karl-Marx-Straße 66
zipCodePostal code; populated for the cinema kind only.
Example: 12043
latitudelongitudedistanceMetersDistance in meters from the searcher location; null when the location is unknown.
Example: 24500
imageRefimageUrlSeat
idcinemaRoomIdseatShapeId
seatTransformId
typeisDboxSeatCategory
idnamepriceChangecinemaIdimageRefimageUrlcolorSeatLock
expireDatetimeidnamepriceTotalpriceNettaxtypereadOnly
readOnly
readOnly
CinApi\User\Dto\UserDtoInterface | null · readOnly
createdDatetimestatereadOnly · deprecated
readOnly · deprecated
SeatPosition
idnameseatRowIdreadOnly
ShowingSeatLock
expireDatetimeshowingIdidnamepriceTotalpriceNettaxtypereadOnly
readOnly
readOnly
CinApi\User\Dto\UserDtoInterface | null · readOnly
createdDatetimestatereadOnly · deprecated
readOnly · deprecated
Showing
contentIdeventRequestIdnameisThreeDimensionalisRegularShowtimeidcinemaRoomIdstartDatetimeendDatetimestateisDolbyAtmoslanguageoriginalLanguageisOriginalLanguageisDubbeddubbedLanguageisSubtitledsubtitledLanguagecineamoMovieIdmovieIdonlineTicketUrlreadOnly
readOnly
CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly
cinemaIdreadOnly
imageUrlreadOnly
highlightAfterDatetimehighlightTextstartSaleDatetimeendSaleDatetimeisImaxisDolbyVisionisDolbyCinemais4DXisScreenXisLiveisHFRisDboxticketUrlsbookingUrlExternalshowingTagIdsIDs of tags attached to this showing
Example: [1,5,12]
isPreviewTrue when the showing starts on the movie's cinema release date in the cinema's country — a preview screening or release-day showing. Null when the start date, the cinema country or the movie release dates are unknown.
Example: true
protectedColumnsProperty names that will not be overridden during showtime import
Example: ["language","subtitledLanguage","isOriginalLanguage"]
isPremiereDeprecated: use isPreview instead (CIN-14521 renamed the concept). Same value, kept so already-released clients — including the mobile apps — keep working.
Example: true
TicketUrl
defaultwebiosandroidcinemaWebsiteShowingTag
idnamecinemaIdcolordescriptionpositionimageRefimageUrlimageDescriptionSocialMediaTemplate
idcinemaIdnamedocumentcreatedAtupdatedAtversionTenant
idnameslugtypestatusentityIdparentIdsettingscreatedAtThread
User · required
id
topicslugtexttagscreatorTypecreatedDatetimecommentsCountThreadTag
textidreadOnly
threadsCountTicket
Showing · required
priceidreadOnly
numberCinApi\User\Dto\UserDtoInterface | null · readOnly
createdDatetimevalidatedDatetimeticketSystemIdscannerTypeTicketPurchaseIntent
idShowing · required
purchaseReasondeviceTypeconfirmedTicketsCountadClickUidTicketSystemFeeRule
idticketSystemEnum values:
compeso_cloudticket
compeso_cine_order
international_showtimes
cinetixx
ticket_international
mars_edv
simevent
kinoheld
Example: cinetixx
channelGroupEnum values:
cinema
cineamo
Example: cinema
cinemaIdfeeCentsvalidFromcreatedDatetimeupdatedDatetimeTimeSlot
idCinApi\CinemaRoom\Dto\CinemaRoomDtoInterface | null · readOnly
dayOfWeekstartTimeendTimereadOnly
UserDetail
idusernameemailfirstNamelastNamecityprofileImageRefprofileImageUrlisActivatedbirthDateisRealNameDisplayEnabledregisterDatetimeisDeletedrolesUser
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeUserMe
idusernameemailisActivatedfirstNamelastNameprofileImageRefprofileImageUrlstreetNumberpostalCodecityphonebirthDateisRealNameDisplayEnabledpreferredLocalerolesarray | null · readOnly
preferredLanguageUserMeExtendedDto
idusernameemailisActivatedfirstNamelastNameprofileImageRefprofileImageUrlstreetNumberpostalCodecityphonebirthDateisRealNameDisplayEnabledpreferredLocalerolesarray | null · readOnly
preferredLanguageUserFeedback
User · required
iddevicecontextvaluecommentcreatedDatetimeUserMovieListItem
UserMovieList · required
idreadOnly