get_users: Get list of users

View source: R/get_users.R

get_usersR Documentation

Get list of users

Description

Retrieves a list of all users for the company designated by the auth token.

Usage

get_users(company_id = Sys.getenv("AW_COMPANY_ID"), limit = 10, page = 0)

Arguments

company_id

Company ID. If an environment variable called AW_COMPANY_ID exists in .Renviron or elsewhere and no company_id argument is provided, then the AW_COMPANY_ID value will be used. Use get_me to get a list of available company_id values.

limit

The number of results to return per page. This argument works in conjunction with the page argument. The default is 10.

page

The "page" of results to display. This works in conjunction with the limit argument and is zero-based. For instance, if limit = 20 and page = 1, the results returned would be 21 through 40.

Value

A data frame of users and their meta data.

Examples

## Not run: 
get_users(limit = 10, page = 0)

## End(Not run)


adobeanalyticsr documentation built on Oct. 18, 2022, 5:06 p.m.