dwapi (version 0.1.3.1)

get_insights: Get insights for a project.

Description

Get insights for a project.

Usage

get_insights(project_owner, project_id, limit = NULL,
  next_page_token = NULL)

Arguments

project_owner

username of the owner of the project.

project_id

identifier of the project.

limit

Maximum number of items to return

next_page_token

Unique token used to retrieve next page

Value

a named list with at most two elements. It will always contain a list, named records, of objects of type insight_summary_response. If the call to get_insights() was made with a non-null limit parameter, and if further pages remain for retrieval, then the list will also contain a single-element character vector, named next_page_token, with the token to use in a subsequent call to get the next page.

Examples

# NOT RUN {
  dwapi::get_insights(project_owner = "user", project_id = "project_id")
# }