Resources Enums Models Unions Clients
Error in generator ts_sdk: The "url" argument must be of type string. Received undefined TypeError [ERR_INVALID_ARG_TYPE]: The "url" argument must be of type string. Received undefined at validateString (internal/validators.js:120:11) at Url.parse (url.js:160:3) at Object.urlParse [as parse] (url.js:155:13) at buildHttpClientClass (/opt/apibuilder/dist/generators/ts_sdk/index.js:526:67) at buildFile (/opt/apibuilder/dist/generators/ts_sdk/index.js:1842:150) at /opt/apibuilder/dist/generators/ts_sdk/index.js:1866:21 at new Promise (<anonymous>) at Object.generate (/opt/apibuilder/dist/generators/ts_sdk/index.js:1858:12) at Layer.<anonymous> (/opt/apibuilder/dist/server/app.js:84:19) at /opt/apibuilder/node_modules/dd-trace/packages/datadog-plugin-router/src/index.js:110:19

reporting-api 0.0.1

History | Watch

Reporting service which aggregates events from dedicated Kafka topics.

  • Contact: N/A
  • License: MIT

Resources

query_response

Query data and display it with a given projection.

Operations

Method and Path Description
POST /query

topic

Operations

Method and Path Description
GET /topics
GET /topics/:guid

view

Operations

Method and Path Description
GET /views
GET /views/:guid
POST /views
PUT /views/:guid
DELETE /views/:guid

Headers

No headers

Imports

https://app.apibuilder.io/nccloud/common/latest/service.json

Enums

scalar_type

A type for a topic's schema field.

Name Value Description
boolean boolean
date-iso8601 date-iso8601
date-time-iso8601 date-time-iso8601
decimal decimal
double double
integer integer
long long
string string
uuid uuid
object object

Note: when a type is set to object, the additional fields must be defined in the schema.

Interfaces

No interfaces

Models

delete_event

Example Json: Minimal | Full

Interfaces: None

Deletes a reporting entity defined by its tracking_id.

Field Type Required? Default Description
tracking_id string Yes -

A unique id, which identifies the association of multiple events. This can i.e. be a user guid, for events related to a user. It is important, that this id is unique and immutable.
audit de.nccloud.common.v0.models.audit:0.0.1 Yes -

Audit information about this event.

field

Example Json: Minimal | Full

Interfaces: None

Single field of a topic schema. A field can be used for projecting, filtering and sorting in reports.

Field Type Required? Default Description
type scalar_type Yes -

The (scalar) type of the field. Fields can only be primitive types.
is_array boolean Yes -

Setting this to true means the field is an array of given type.
fields map[field] No -

Nested fields for type object. When defining fields but not having set the type to object, the fields will be ignored. When setting the type to object, the fields need to be defined.
label string No -

A human-readable label for the field.
description string No -

A human-readable description of the field.

filter

Example Json: Minimal | Full

Interfaces: None

Defines a condition for values.

Field Type Required? Default Description
expression string No -

An SQL-like expression.
variables map[json] No -

A map of values, which can be used in the expression. Variables can be access by prepending them with $.

projection_field

Example Json: Minimal | Full

Interfaces: None

A single field of a projection schema.

Field Type Required? Default Description
label string No -

A human-readable label for the field.
description string No -

A human-readable description for the field.
source projection_field_source No -

The source of the field. Either source or fields must be set.
fields map[projection_field] No -

Defines nested fields for this projection. Either source or fields must be set.

projection_field_source

Example Json: Minimal | Full

Interfaces: None

Represents the source for a single projection field from a topic's schema.

Field Type Required? Default Description
topic string Yes -

Name of the originating topic.
path string Yes -

A slimmed down variant of JSON Path to point to a specific field in a topic's schema.
filter string Yes -

A conditional filter expression. The expression can contain variables, which will be passed in when evaluating the projection.

query_form

Example Json: Minimal | Full

Interfaces: None

Form for querying and projecting data.

Field Type Required? Default Description
view string No -

The name of a defined view used for projecting. If the view defines variables, they must be provided as well. Either view or projection must be set.
projection map[projection_field] No -

Projected fields to return. Either view or projection must be set.
variables map[json] Yes -

Variables to pass to the projection or the view.
sort [de.nccloud.common.v0.models.sort:0.0.1] No -

The defined properties refer to the fields of the projection.

query_response

Example Json: Minimal | Full

Interfaces: None

The result of a query, returning data in a projected form.

Field Type Required? Default Description
page de.nccloud.common.v0.models.page_response:0.0.1 Yes -

data object Yes -

The returned data in the projected form.

topic

Example Json: Minimal | Full

Interfaces: None

Represents a single topic, which will be consumed by the reporting service.

Field Type Required? Default Description
name string Yes -

service de.nccloud.common.v0.models.service_info:0.0.1 Yes -

Info about the producing service.
schema map[field] Yes -

The schema of the topics' provided data.

topic_response

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
page de.nccloud.common.v0.models.page_response:0.0.1 Yes -

data [topic] Yes -

update_event

Example Json: Minimal | Full

Interfaces: None

Updates one or more data fields.

Field Type Required? Default Description
tracking_id string Yes -

A unique id, which identifies the association of multiple events. This can i.e. be a user guid, for events related to a user. It is important, that this id is unique and immutable.
payload object Yes -

One or more fields defined in the reporting schema, which will be updated.
audit de.nccloud.common.v0.models.audit:0.0.1 Yes -

Audit information about this event.

view

Example Json: Minimal | Full

Interfaces: None

A stored view containing data from one or more topics.

Field Type Required? Default Description
guid uuid Yes -

Globally unique identifier of the projection.
name string Yes -

Name of this projection used to reference it in a human-friendly way. The name must be unique.
projection map[projection_field] Yes -

Projected fields of this view.
variables map[scalar_type] Yes -

Definition of variables which can be passed to the view. All scalar_types are allowed, except object.

view_form

Example Json: Minimal | Full

Interfaces: None

Form for creating a new view.

Field Type Required? Default Description
name string Yes -

Name of the view.
projection map[projection_field] Yes -

Projected fields of this view.
variables map[scalar_type] Yes -

Definition of variables which can be passed to the view. All scalar_types are allowed, except object.

view_response

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
page de.nccloud.common.v0.models.page_response:0.0.1 Yes -

data [view] Yes -

Unions

reporting_event

Interfaces: None

  • Type discriminator: type
Type Discriminator Value Example Json Description
update_event update_event Minimal | Full

delete_event delete_event Minimal | Full

Annotations

No annotations