LYlytics
Reports

Create a new Report Component

Changed on

Add a new Report Component to the Report. If the component already exists, it will be updated. To create a new Component, you will need to specify the type, name, and config fields. Depending on the Component type, you may need to specify additional fields in the config object.

For size components, you will need to specify the segment_ids field ([]string) in the config object.

For composition components, you will need to specify the segment_ids ([]string) field and a field (string) from the user schema in the config object.

For overflow components, you will need to specify the segment_ids ([]string) field in the config object.

For dataflow components, you will need to specify the segment_ids ([]string) field in the config object, as well as show_providers, show_streams, and show_destinations (boolean) options.

post/report/{id}/component

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/report/{id}/component
  • Auth
    API key in header Authorization

Path parameters

idstring required

The report ID

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

Request body */*

configunknown
descriptionstring

An optional description of the component

idstring
namestring required

The name of the component to be used in the Report.

type'size' | 'composition' | 'overlap' | 'dataflow' required

The type of component to be used in the Report.

Response

Report Response

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes