List available reports

GET

/api/v1/{bucket}/reports

• Production
• Development

Returns all pre-built report definitions. Optionally filter by a search query that matches against report name, description, category, and tags.

Authorizations

• BearerAuth
• ApiKeyAuth

Parameters

Path Parameters

bucket

required

string

/^[a-zA-Z0-9][a-zA-Z0-9\-]*$/

Flock bucket ID. The caller must have access to this bucket.

Example

example

Query Parameters

q

string

Search query to filter reports by name, description, category, or tags.

Example

membership

Responses

200

List of reports

object

data

required

Array<object>

object

id

required

string

Example

age_summary

name

required

string

Example

Age Summary

description

required

string

Example

Counts people by age band. Excludes deceased.

category

required

string

Allowed values: people membership finance fundraising

Example

people

tags

required

Array<string>

Example

[
  "age",
  "demographics"
]

Example

{
  "data": [
    {
      "id": "age_summary",
      "name": "Age Summary",
      "description": "Counts people by age band. Excludes deceased.",
      "category": "people",
      "tags": [
        "age",
        "demographics",
        "birthday",
        "dob"
      ]
    }
  ]
}

401

Authentication required

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

403

Access denied to bucket

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "forbidden",
    "message": "Access denied to bucket 'example'"
  }
}