For the complete documentation index, see llms.txt. This page is also available as Markdown.

Platform Monitoring

Operations for monitoring ingestion, resource consumption, and datamart collection sizes.

Fetch datamart resource consumption available metrics

get
/platform_monitoring/resources_usage/metrics
Query parameters
datamart_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/platform_monitoring/resources_usage/metrics
GET /v1/platform_monitoring/resources_usage/metrics?datamart_id=text HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "metrics": [
      "text"
    ]
  }
}

Fetch pipeline ingestion analytics dimensions

get
/platform_monitoring/data_ingestion/dimensions
Query parameters
datamart_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/platform_monitoring/data_ingestion/dimensions
GET /v1/platform_monitoring/data_ingestion/dimensions?datamart_id=text HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "dimensions": [
      "text"
    ]
  }
}

Fetch datamart resource consumption dimensions

get
/platform_monitoring/resources_usage/dimensions
Query parameters
datamart_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/platform_monitoring/resources_usage/dimensions
GET /v1/platform_monitoring/resources_usage/dimensions?datamart_id=text HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "dimensions": [
      "text"
    ]
  }
}

Fetch pipeline ingestion analytics available metrics

get
/platform_monitoring/data_ingestion/metrics
Query parameters
datamart_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/platform_monitoring/data_ingestion/metrics
GET /v1/platform_monitoring/data_ingestion/metrics?datamart_id=text HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "metrics": [
      "text"
    ]
  }
}

get metrics about the number of events ingested

post
/platform_monitoring/data_ingestion
Body
sample_factorinteger · int32OptionalDefault: 0
max_resultinteger · int32OptionalDefault: 0
first_resultinteger · int32OptionalDefault: 0
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/platform_monitoring/data_ingestion
POST /v1/platform_monitoring/data_ingestion HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 585

{
  "dimensions": [
    {
      "name": "text"
    }
  ],
  "sample_factor": 0,
  "metrics": [
    {
      "expression": "text",
      "alias": "text",
      "formatting_type": "INTEGER"
    }
  ],
  "dimension_filter_clauses": {
    "operator": "OR",
    "filters": [
      {
        "dimension_name": "text",
        "case_sensitive": false,
        "expressions": [
          "text"
        ],
        "operator": "EXACT",
        "not": false
      }
    ]
  },
  "order_by": {
    "field_name": "text",
    "sort_order": "ASCENDING"
  },
  "max_result": 0,
  "metric_filter_clauses": {
    "operator": "OR",
    "filters": [
      {
        "metric_name": "text",
        "not": false,
        "operator": "EQUAL",
        "comparison_value": "text"
      }
    ]
  },
  "first_result": 0,
  "date_ranges": [
    {
      "start_date": "text",
      "end_date": "text",
      "timezone": "text"
    }
  ]
}
{
  "status": "ok",
  "data": {
    "items_per_page": 0,
    "total_items": 0,
    "columns_headers": [
      "text"
    ],
    "rows": [
      [
        {}
      ]
    ]
  }
}

get metrics about datamart resource consumption

post
/platform_monitoring/resources_usage
Body
sample_factorinteger · int32OptionalDefault: 0
max_resultinteger · int32OptionalDefault: 0
first_resultinteger · int32OptionalDefault: 0
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/platform_monitoring/resources_usage
POST /v1/platform_monitoring/resources_usage HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 585

{
  "dimensions": [
    {
      "name": "text"
    }
  ],
  "sample_factor": 0,
  "metrics": [
    {
      "expression": "text",
      "alias": "text",
      "formatting_type": "INTEGER"
    }
  ],
  "dimension_filter_clauses": {
    "operator": "OR",
    "filters": [
      {
        "dimension_name": "text",
        "case_sensitive": false,
        "expressions": [
          "text"
        ],
        "operator": "EXACT",
        "not": false
      }
    ]
  },
  "order_by": {
    "field_name": "text",
    "sort_order": "ASCENDING"
  },
  "max_result": 0,
  "metric_filter_clauses": {
    "operator": "OR",
    "filters": [
      {
        "metric_name": "text",
        "not": false,
        "operator": "EQUAL",
        "comparison_value": "text"
      }
    ]
  },
  "first_result": 0,
  "date_ranges": [
    {
      "start_date": "text",
      "end_date": "text",
      "timezone": "text"
    }
  ]
}
{
  "status": "ok",
  "data": {
    "items_per_page": 0,
    "total_items": 0,
    "columns_headers": [
      "text"
    ],
    "rows": [
      [
        {}
      ]
    ]
  }
}

Fetch datamart collection sizes available metrics

get
/platform_monitoring/collections/metrics
Query parameters
datamart_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/platform_monitoring/collections/metrics
GET /v1/platform_monitoring/collections/metrics?datamart_id=text HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "metrics": [
      "text"
    ]
  }
}

Fetch datamart collection sizes dimensions

get
/platform_monitoring/collections/dimensions
Query parameters
datamart_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/platform_monitoring/collections/dimensions
GET /v1/platform_monitoring/collections/dimensions?datamart_id=text HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "dimensions": [
      "text"
    ]
  }
}

get metrics about datamart collection sizes

post
/platform_monitoring/collections
Body
sample_factorinteger · int32OptionalDefault: 0
max_resultinteger · int32OptionalDefault: 0
first_resultinteger · int32OptionalDefault: 0
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/platform_monitoring/collections
POST /v1/platform_monitoring/collections HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 585

{
  "dimensions": [
    {
      "name": "text"
    }
  ],
  "sample_factor": 0,
  "metrics": [
    {
      "expression": "text",
      "alias": "text",
      "formatting_type": "INTEGER"
    }
  ],
  "dimension_filter_clauses": {
    "operator": "OR",
    "filters": [
      {
        "dimension_name": "text",
        "case_sensitive": false,
        "expressions": [
          "text"
        ],
        "operator": "EXACT",
        "not": false
      }
    ]
  },
  "order_by": {
    "field_name": "text",
    "sort_order": "ASCENDING"
  },
  "max_result": 0,
  "metric_filter_clauses": {
    "operator": "OR",
    "filters": [
      {
        "metric_name": "text",
        "not": false,
        "operator": "EQUAL",
        "comparison_value": "text"
      }
    ]
  },
  "first_result": 0,
  "date_ranges": [
    {
      "start_date": "text",
      "end_date": "text",
      "timezone": "text"
    }
  ]
}
{
  "status": "ok",
  "data": {
    "items_per_page": 0,
    "total_items": 0,
    "columns_headers": [
      "text"
    ],
    "rows": [
      [
        {}
      ]
    ]
  }
}

Last updated

Was this helpful?