Params

Param name Description
id
required

Collection ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Collection information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][name]
optional

Validations:

  • Must be a String

data[attributes][description]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][cover-image]
optional , nil allowed

Collection's cover image file in data URL format

Validations:

  • Must be a String

data[attributes][cover-image-file-name]
optional , nil allowed

Collection's cover image file name

Validations:

  • Must be a String

data[attributes][and-filters]
optional , nil allowed

Collection's filters

Validations:

  • Must be a Hash

data[attributes][and-filters][vertical-ids]
optional , nil allowed

Filter insight/report by vertical ids

Validations:

  • Must be a String

data[attributes][and-filters][countries]
optional , nil allowed

Filter insight/report by countries

Validations:

  • Must be a String

data[attributes][and-filters][sectors]
optional , nil allowed

Filter insight/report by sectors

Validations:

  • Must be a String

data[attributes][and-filters][market-cap]
optional , nil allowed

Filter insight/report by market cap

Validations:

  • Must be a String

data[attributes][and-filters][imperative]
optional , nil allowed

Filter insight/report by imperative

Validations:

  • Must be a String

data[attributes][and-filters][entity_ids]
optional , nil allowed

Filter insight/report by entity_ids

Validations:

  • Must be a String

data[attributes][and-filters][primary_entity_ids]
optional , nil allowed

Filter insight/report by primary_entity_ids

Validations:

  • Must be a String

data[attributes][and-filters][author_ids]
optional , nil allowed

Filter insight/report by author_ids

Validations:

  • Must be a String

data[attributes][and-filters][search]
optional , nil allowed

Filter insight/report by search

Validations:

  • Must be a String

data[attributes][or-filters]
optional , nil allowed

Collection's filters

Validations:

  • Must be a Hash

data[attributes][or-filters][vertical-ids]
optional , nil allowed

Filter insight/report by vertical ids

Validations:

  • Must be a String

data[attributes][or-filters][countries]
optional , nil allowed

Filter insight/report by countries

Validations:

  • Must be a String

data[attributes][or-filters][sectors]
optional , nil allowed

Filter insight/report by sectors

Validations:

  • Must be a String

data[attributes][or-filters][market-cap]
optional , nil allowed

Filter insight/report by market cap

Validations:

  • Must be a String

data[attributes][or-filters][imperative]
optional , nil allowed

Filter insight/report by imperative

Validations:

  • Must be a String

data[attributes][or-filters][entity_ids]
optional , nil allowed

Filter insight/report by entity_ids

Validations:

  • Must be a String

data[attributes][or-filters][primary_entity_ids]
optional , nil allowed

Filter insight/report by primary_entity_ids

Validations:

  • Must be a String

data[attributes][or-filters][author_ids]
optional , nil allowed

Filter insight/report by author_ids

Validations:

  • Must be a String

data[attributes][or-filters][search]
optional , nil allowed

Filter insight/report by search

Validations:

  • Must be a String