Advertising

Server

Ad campaigns and impression/click tracking.

Create an ad click

POST

https://api.cineamo.com

/advertisements/{advertisementId}/ad-clicks

Creates an AdClick. It returns the AdClick object.

Create an ad click › Request Body

AdClick

id

integer · readOnly

referrerPage

string | null · readOnly

readOnly

client

string | null · readOnly

ipAddress

string | null · readOnly

deviceType

string | null · readOnly

uid

string | null · readOnly

Create an ad click › Responses

AdClick creation was scheduled

No data returned

POST/advertisements/{advertisementId}/ad-clicks

curl https://api.cineamo.com/advertisements/:advertisementId/ad-clicks \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "referrerPage": "some URL",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "client": "web",
  "ipAddress": "127.0.0.1",
  "deviceType": "browser",
  "uid": "1537200202186752"
}'

Example Request Body

{
  "id": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "referrerPage": "some URL",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "client": "web",
  "ipAddress": "127.0.0.1",
  "deviceType": "browser",
  "uid": "1537200202186752"
}

json

Example Responses

No example specified for this content type

Create an ad impression

POST

https://api.cineamo.com

/advertisements/{advertisementId}/ad-impressions

Creates an AdImpression. It returns the AdImpression object.

Create an ad impression › Request Body

AdImpression

id

integer · readOnly

referrerPage

string | null · readOnly

readOnly

client

string | null · readOnly

ipAddress

string | null · readOnly

deviceType

string | null · readOnly

uid

string | null · readOnly

Create an ad impression › Responses

AdImpression creation was scheduled

No data returned

POST/advertisements/{advertisementId}/ad-impressions

curl https://api.cineamo.com/advertisements/:advertisementId/ad-impressions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "referrerPage": "some URL",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "client": "web",
  "ipAddress": "127.0.0.1",
  "deviceType": "browser",
  "uid": "1537200202186752"
}'

Example Request Body

{
  "id": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "referrerPage": "some URL",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "client": "web",
  "ipAddress": "127.0.0.1",
  "deviceType": "browser",
  "uid": "1537200202186752"
}

json

Example Responses

No example specified for this content type

List advertisements

GET

https://api.cineamo.com

/advertisements

Returns a list of Advertisement objects.

List advertisements › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

distributorIds

integer[]

startDatetime

string

endDatetime

string

placement

string[]

statuses

string[]

embed

string[]

List advertisements › Responses

Advertisement list

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

cinemaIds

object | null · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

impressionCount

integer · readOnly

impressionThreshold

integer | null · readOnly

clickCount

integer · readOnly

costPer1kImpressions

integer | null · readOnly

maxBudget

integer | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

metricCinemasTotalCount

integer | null · readOnly

metricCinemasDeclinedCount

integer | null · readOnly

metricCinemasAcceptedCount

integer | null · readOnly

GET/advertisements

curl https://api.cineamo.com/advertisements

Example Responses

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}

json

application/json

Create an advertisement

POST

https://api.cineamo.com

/advertisements

Creates an Advertisement. It returns the Advertisement object.

Create an advertisement › Request Body

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

cinemaIds

object | null · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

impressionCount

integer · readOnly

impressionThreshold

integer | null · readOnly

clickCount

integer · readOnly

costPer1kImpressions

integer | null · readOnly

maxBudget

integer | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

metricCinemasTotalCount

integer | null · readOnly

metricCinemasDeclinedCount

integer | null · readOnly

metricCinemasAcceptedCount

integer | null · readOnly

Create an advertisement › Responses

Advertisement was created

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

cinemaIds

object | null · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

impressionCount

integer · readOnly

impressionThreshold

integer | null · readOnly

clickCount

integer · readOnly

costPer1kImpressions

integer | null · readOnly

maxBudget

integer | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

metricCinemasTotalCount

integer | null · readOnly

metricCinemasDeclinedCount

integer | null · readOnly

metricCinemasAcceptedCount

integer | null · readOnly

POST/advertisements

curl https://api.cineamo.com/advertisements \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}'

Example Request Body

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}

json

Example Responses

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}

json

application/json

Get an advertisement

GET

https://api.cineamo.com

/advertisements/{advertisementId}

Returns an Advertisement object by its Id.

Get an advertisement › path Parameters

advertisementId

string · required

Get an advertisement › Responses

Advertisement details

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

cinemaIds

object | null · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

impressionCount

integer · readOnly

impressionThreshold

integer | null · readOnly

clickCount

integer · readOnly

costPer1kImpressions

integer | null · readOnly

maxBudget

integer | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

metricCinemasTotalCount

integer | null · readOnly

metricCinemasDeclinedCount

integer | null · readOnly

metricCinemasAcceptedCount

integer | null · readOnly

GET/advertisements/{advertisementId}

curl https://api.cineamo.com/advertisements/:advertisementId

Example Responses

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}

json

application/json

Delete an advertisement

DELETE

https://api.cineamo.com

/advertisements/{advertisementId}

Deletes an Advertisement. It returns an empty response.

Delete an advertisement › path Parameters

advertisementId

string · required

Delete an advertisement › Responses

Advertisement was deleted

No data returned

Update an advertisement

PATCH

https://api.cineamo.com

/advertisements/{advertisementId}

Updates an Advertisement. It returns the updated Advertisement object.

Update an advertisement › path Parameters

advertisementId

string · required

Update an advertisement › Request Body

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

cinemaIds

object | null · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

impressionCount

integer · readOnly

impressionThreshold

integer | null · readOnly

clickCount

integer · readOnly

costPer1kImpressions

integer | null · readOnly

maxBudget

integer | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

metricCinemasTotalCount

integer | null · readOnly

metricCinemasDeclinedCount

integer | null · readOnly

metricCinemasAcceptedCount

integer | null · readOnly

Update an advertisement › Responses

Advertisement was updated

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

cinemaIds

object | null · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

impressionCount

integer · readOnly

impressionThreshold

integer | null · readOnly

clickCount

integer · readOnly

costPer1kImpressions

integer | null · readOnly

maxBudget

integer | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

metricCinemasTotalCount

integer | null · readOnly

metricCinemasDeclinedCount

integer | null · readOnly

metricCinemasAcceptedCount

integer | null · readOnly

PATCH/advertisements/{advertisementId}

curl https://api.cineamo.com/advertisements/:advertisementId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}'

Example Request Body

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}

json

Example Responses

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "cinemaIds": "[1,2,3]",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "impressionCount": 1,
  "impressionThreshold": 1,
  "clickCount": 1,
  "costPer1kImpressions": 1,
  "maxBudget": 1,
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]",
  "metricCinemasTotalCount": 1,
  "metricCinemasDeclinedCount": 1,
  "metricCinemasAcceptedCount": 1
}

json

application/json

Get an advertisement to display

GET

https://api.cineamo.com

/advertisements/display

Suggests an Advertisement to display.

Get an advertisement to display › path Parameters

cinemaId

string · required

Get an advertisement to display › query Parameters

placements

string[]

displayLocations

string[]

embed

string[]

Get an advertisement to display › Responses

Advertisement details

AdvertisementMinimum

id

integer · readOnly

MovieCopyright

startDatetime

string · readOnly

endDatetime

string · readOnly

clickThroughUrl

string | null · readOnly

topBannerImageRef

string | null · readOnly

topBannerImageUrl

string | null · readOnly

topBannerDesktopImageRef

string | null · readOnly

topBannerDesktopImageUrl

string | null · readOnly

layerImageRef

string | null · readOnly

layerImageUrl

string | null · readOnly

placement

object | null · readOnly

status

string · readOnly

displayLocations

object | null · readOnly

GET/advertisements/display

curl https://api.cineamo.com/advertisements/display

Example Responses

{
  "id": 1,
  "movieCopyright": {
    "id": 1,
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "createdDatetime": "2022-011-17T04:11:22Z",
    "isCreatedByDistributor": false,
    "isLicensed": false,
    "internalDistributorMovieId": "1",
    "startDatetime": "2022-011-17T04:11:22Z",
    "endDatetime": "2022-011-17T04:11:22Z",
    "distributor": {
      "id": 1,
      "name": "some cinema name",
      "slug": "some-cinema-name",
      "email": "some@email.com",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "isActive": "true",
      "isEnabledDefaultConditions": "true",
      "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000",
      "countryCode": "DE"
    },
    "source": "source",
    "eventRequestsCount": 1
  },
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T06:11:22Z",
  "clickThroughUrl": "some URL",
  "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
  "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
  "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
  "layerImageRef": "00000000-0000-0000-0000-000000000000",
  "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
  "placement": "[\"top_banner\"]",
  "status": "scheduled",
  "displayLocations": "[\"ios\", \"web\"]"
}

json

application/json

Seats Deals