RP_APIGetReferenceData: RP_APIGetReferenceData

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIGetReferenceDataR Documentation

RP_APIGetReferenceData

Description

Retrieve an entity reference data file. An entity mapping file contains information pertaining to entities in RavenPack’s entity universe. Files are updated on a daily basis after midnight UTC. It is possible to request a reference data file for a specific entity type by supplying the entity_type parameter. For more information, please see the Reference Service section in the RavenPack Analytics User Guide.

Usage

RP_APIGetReferenceData(APIHandler, params = list())

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler

params

A list with the request query parameters.

  • entity_type: Optional. A single entity type. If not provided all are requested.

Value

An url with a link to the csv file upon success. An http server response otherwise.

Author(s)

Jose A. Guerrero-Colon


RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.