Skip to contents

Retrieve metadata for a referent

Source: R/annotations.R
get_referent.Rd

The Genius API lets you return data for a specific referent. get_referent returns this data in full.

Usage

get_referent(
  created_by_id,
  song_id,
  web_page_id,
  access_token = genius_token()
)

Arguments

created_by_id

ID of a user to get referents for

song_id

ID of a song to get referents for (pass only one of song_id and web_page_id)

web_page_id

ID of a web page to get referents for (pass only one of song_id and web_page_id)

access_token

Genius' client access token, defaults to genius_token

Value

a genius_referent object that contains the extracted content from the request, the original JSON response object and the request path.

Details

Referents are the sections of a piece of content to which annotations are attached. Each referent is associated with a web page or a song and may have one or more annotations. Referents can be searched by the document they are attached to or by the user that created them.

See also

Other annotation: get_annotation()

Examples

if (FALSE) {
get_referent(song_id = 3039923)
}