Skip to main content
GET
Get attributes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

Number of page. Stars from the first (1) page.

per_page
integer

Number of records to return.

resolve
boolean

When true (the default), $ref type references are resolved and the referenced attribute's type definition is returned in their place. When false, the raw $ref node is returned as stored.

q
string

Free-text search term. When provided, attributes are ranked by their relevance to the search term.

min_score
number<double>

Optional minimum relevance score, in the half-open interval (0, 1]. By default no threshold is applied and all matches are returned, ranked by relevance. Supply min_score to restrict the results to attributes scoring at or above the given value; below-threshold attributes are then excluded from both the results and the total count. Can only be supplied together with q; supplying it without q returns 400.

Required range: x <= 1

Response

OK

One page of attributes. When the request carries no paging parameters, every record is returned in a single page.

records
object[]
required

An attribute models a standardized data point available for sale on the Narrative marketplace.

Narrative automatically turns data points from provider datasets into attributes so that buyers can purchase well-formed, standardized data from any supplier on the marketplace.

The response will be one of two types:

  • AttributeOwnedResponse: When the requesting company owns the attribute (includes company_id and collaborators)
  • AttributeSharedResponse: When the requesting company does not own the attribute
Example:
current_page
integer<int64>
required

The number of requested page.

Example:

1

total_records
integer<int64>
required

Total amount of accessible Access Rules

Example:

15000

total_pages
integer<int64>
required

Total amount of pages.

Example:

10

prev_page
integer<int64> | null

The number of the previous page, or null on the first page. Can also refer to the latest existing page if a page beyond the last one was requested.

Example:

1

next_page
integer<int64> | null

The number of the next page, or null on the last page.

Example:

42