Flow Metric Value Summaries

List Flow Metric Value Summaries

get

List all flow metric value summaries.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• model

• model_count

• modelExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• model_type

• model_id

• interval_unit

• key

• for_month

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• created_at

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

filter[interval_unit]stringOptional

Filter results by interval_unit.

filter[key]stringOptional

Filter results by key.

filter[for_month]stringOptional

Filter results by for_month.

includestringOptional

Comma-separated list of relationships to include. Available: model

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-metric-value-summaries

GET /api/v1/flow-metric-value-summaries HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-metric-value-summaries",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-metric-value-summaries?page=1",
    "last": "https://api.example.com/api/v1/flow-metric-value-summaries?page=1",
    "prev": null,
    "next": null
  }
}