Datasets

Facet the Box Office Mojo dataset

Returns terms-aggregation counts for one facet of the Box Office Mojo dataset, scoped to the same filters as search. Facet enum: gross_band, years_active, lifetime_year, franchise_names, brand_names, genre_names, hydrated, is_billion_dollar, in_lifetime_top_1000_ww. gross_band enum: under_50m, 50_100m, 100_250m, 250_500m, 500m_1b, over_1b.

get/datasets/boxofficemojo/facets

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/boxofficemojo/facets
  • Auth: API key in header x-api-key

Query parameters

facet'gross_band' | 'years_active' | 'lifetime_year' | 'franchise_names' | 'brand_names' | 'genre_names' | 'hydrated' | 'is_billion_dollar' | 'in_lifetime_top_1000_ww' required

Facet enum: gross_band, years_active, lifetime_year, franchise_names, brand_names, genre_names, hydrated, is_billion_dollar, in_lifetime_top_1000_ww

qstring

Full-text query, max 256 characters

title_idstring

Exact title id (IMDb tt… id used by Box Office Mojo), max 32 characters

yearinteger

Year in years_active

lifetime_yearinteger

Primary lifetime chart year

gross_bandstring

Gross band filter

franchisestring

Franchise name filter, max 128 characters

brandstring

Brand name filter, max 128 characters

genrestring

Genre name filter, max 128 characters

in_lifetime_top_1000boolean

Only titles in the lifetime worldwide top 1000 chart

min_worldwideinteger

Minimum lifetime worldwide gross

max_worldwideinteger

Maximum lifetime worldwide gross

min_domesticinteger

Minimum lifetime domestic gross

min_foreign_sharenumber

Minimum foreign share of worldwide gross, 0 through 1

max_domestic_sharenumber

Maximum domestic share of worldwide gross, 0 through 1

hydratedboolean

Hydrated filter

is_billion_dollarboolean

Only titles with worldwide gross of at least $1B

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.