Distributors

Server

Film distributors.

List distributor advertisements

GET

https://api.cineamo.com

/distributors/{distributorId:\d+}/advertisements

Returns a list of Advertisement objects.

List distributor advertisements › path Parameters

distributorId

string · required

List distributor advertisements › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

startDatetime

string

endDatetime

string

placement

string[]

statuses

string[]

embed

string[]

List distributor 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/distributors/{distributorId:\d+}/advertisements

curl 'https://api.cineamo.com/distributors/:distributorId:\d+/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

List distributor cinema advertisements

GET

https://api.cineamo.com

/distributors/{distributorId:\d+}/cinema-advertisements

Returns a list of CinemaAdvertisement objects.

List distributor cinema advertisements › path Parameters

distributorId

string · required

List distributor cinema advertisements › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

embed

string[]

List distributor cinema advertisements › Responses

DistributorCinemaAdvertisement list

CinemaAdvertisement

cinemaId

integer | null · readOnly

CinemaMinimum

advertisementId

integer | null · readOnly

isDeclined

boolean · readOnly

matchesCinemaShowings

boolean · readOnly

GET/distributors/{distributorId:\d+}/cinema-advertisements

curl 'https://api.cineamo.com/distributors/:distributorId:\d+/cinema-advertisements'

Example Responses

{
  "cinemaId": 1,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  },
  "advertisementId": 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
  },
  "isDeclined": "true",
  "matchesCinemaShowings": "true"
}

json

application/json

List distributors

GET

https://api.cineamo.com

/distributors

Returns a list of Distributor objects.

List distributors › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

employedUserId

string

movieId

string

countryCode

string

List distributors › Responses

200

Distributor list

No data returned

Create a distributor

POST

https://api.cineamo.com

/distributors

Creates a distributor. Returns the created distributor.

Create a distributor › Request Body

Distributor

id

integer · readOnly · required

name

string · readOnly · required

slug

string | null · readOnly · required

email

string · readOnly · required

description

string | null · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

isActive

boolean · readOnly

isEnabledDefaultConditions

boolean · readOnly

defaultConditionsAlternativeText

string | null · readOnly

imageUrl

string | null · readOnly

imageRef

string | null · readOnly

countryCode

string | null · readOnly

Create a distributor › Responses

Distributor was created

Distributor

id

integer · readOnly · required

name

string · readOnly · required

slug

string | null · readOnly · required

email

string · readOnly · required

description

string | null · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

isActive

boolean · readOnly

isEnabledDefaultConditions

boolean · readOnly

defaultConditionsAlternativeText

string | null · readOnly

imageUrl

string | null · readOnly

imageRef

string | null · readOnly

countryCode

string | null · readOnly

POST/distributors

curl https://api.cineamo.com/distributors \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'

Example Request Body

{
  "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"
}

json

Example Responses

{
  "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"
}

json

application/json

Get a distributor

GET

https://api.cineamo.com

/distributors/{distributorId}

Returns the requested distributor.

Get a distributor › path Parameters

distributorId

string · required

Get a distributor › Responses

Distributor details

No data returned

Update a distributor

PATCH

https://api.cineamo.com

/distributors/{distributorId}

Updates a distributor. Returns the updated distributor.

Update a distributor › path Parameters

distributorId

string · required

Update a distributor › Request Body

Distributor

id

integer · readOnly · required

name

string · readOnly · required

slug

string | null · readOnly · required

email

string · readOnly · required

description

string | null · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

isActive

boolean · readOnly

isEnabledDefaultConditions

boolean · readOnly

defaultConditionsAlternativeText

string | null · readOnly

imageUrl

string | null · readOnly

imageRef

string | null · readOnly

countryCode

string | null · readOnly

Update a distributor › Responses

Distributor was updated

Distributor

id

integer · readOnly · required

name

string · readOnly · required

slug

string | null · readOnly · required

email

string · readOnly · required

description

string | null · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

isActive

boolean · readOnly

isEnabledDefaultConditions

boolean · readOnly

defaultConditionsAlternativeText

string | null · readOnly

imageUrl

string | null · readOnly

imageRef

string | null · readOnly

countryCode

string | null · readOnly

PATCH/distributors/{distributorId}

curl https://api.cineamo.com/distributors/:distributorId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'

Example Request Body

{
  "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"
}

json

Example Responses

{
  "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"
}

json

application/json

Get a distributor advertisement clicks count

GET

https://api.cineamo.com

/distributors/{distributorId:\d+}/advertisements/{advertisementId:\d+}/clicks-count

Returns the requested distributor advertisement clicks count.

Get a distributor advertisement clicks count › path Parameters

distributorId

string · required

advertisementId

string · required

Get a distributor advertisement clicks count › query Parameters

cinemaIds

integer[]

placements

string[]

clients

string[]

deviceTypes

string[]

Get a distributor advertisement clicks count › Responses

200

DistributorAdvertisementClicksCount number

No data returned

Get a distributor advertisement impressions count

GET

https://api.cineamo.com

/distributors/{distributorId:\d+}/advertisements/{advertisementId:\d+}/impressions-count

Returns the requested distributor advertisement impressions count.

Get a distributor advertisement impressions count › path Parameters

distributorId

string · required

advertisementId

string · required

Get a distributor advertisement impressions count › query Parameters

cinemaIds

integer[]

placements

string[]

clients

string[]

deviceTypes

string[]

Get a distributor advertisement impressions count › Responses

200

DistributorAdvertisementImpressionsCount number

No data returned

Deals Distributor Statistics