# Tailglow

> Analytics and monitoring platform. Send records to a source, shape them into views with the
> TGL transform language, aggregate them into metrics, and watch them with monitors.

Every link below is markdown. Each API section lists that resource's operations with the HTTP
verb and path needed to call them; follow a link for field-level request and response detail.
Start with API Fundamentals: it carries the authentication, error envelope and pagination
contracts every operation shares. A single file containing everything is at /llms-full.txt.

## API Fundamentals

- [Errors](/api/errors.md)
- [Enums](/api/enums.md)
- [Introduction](/api/introduction.md)

## Projects

- [Project Model](/api/projects.md#project-model)
- [Late Data Model](/api/projects.md#late-data-model)
- [Live Pipeline Model](/api/projects.md#live-pipeline-model)
- [Usage Sample Model](/api/projects.md#usage-sample-model)
- [Attention Item Model](/api/projects.md#attention-item-model)
- [List Projects](/api/projects.md#list-projects): GET /v1/projects
- [Retrieve Project](/api/projects.md#retrieve-project): GET /v1/projects/:project_id
- [Retrieve Project Pipeline](/api/projects.md#retrieve-project-pipeline): GET /v1/projects/:project_id/pipeline
- [Retrieve Live Project Pipeline](/api/projects.md#retrieve-live-project-pipeline): GET /v1/projects/:project_id/pipeline/live
- [Create Project](/api/projects.md#create-project): POST /v1/projects
- [Update Project](/api/projects.md#update-project): POST /v1/projects/:project_id
- [Delete Project](/api/projects.md#delete-project): DELETE /v1/projects/:project_id
- [Force Delete Project](/api/projects.md#force-delete-project): DELETE /v1/projects/:project_id/force
- [List Late Data](/api/projects.md#list-late-data): GET /v1/projects/:project_id/late_data
- [Re-backfill Late Data](/api/projects.md#re-backfill-late-data): POST /v1/projects/:project_id/late_data/:late_data_file_id/re_backfill
- [Retrieve Project Usage](/api/projects.md#retrieve-project-usage): GET /v1/projects/:project_id/usage
- [Retrieve Project Attention](/api/projects.md#retrieve-project-attention): GET /v1/projects/:project_id/attention

## Sources

- [Source Model](/api/sources.md#source-model)
- [List Sources](/api/sources.md#list-sources): GET /v1/projects/:project_id/sources
- [Retrieve Source](/api/sources.md#retrieve-source): GET /v1/projects/:project_id/sources/:source_id
- [Create Source](/api/sources.md#create-source): POST /v1/projects/:project_id/sources
- [Update Source](/api/sources.md#update-source): POST /v1/projects/:project_id/sources/:source_id
- [Delete Source](/api/sources.md#delete-source): DELETE /v1/projects/:project_id/sources/:source_id
- [Force Delete Source](/api/sources.md#force-delete-source): DELETE /v1/projects/:project_id/sources/:source_id/force

## Ingest Keys

- [Ingest Key Model](/api/ingest_keys.md#ingest-key-model)
- [List Ingest Keys](/api/ingest_keys.md#list-ingest-keys): GET /v1/projects/:project_id/sources/:source_id/ingest_keys
- [Retrieve Ingest Key](/api/ingest_keys.md#retrieve-ingest-key): GET /v1/projects/:project_id/sources/:source_id/ingest_keys/:ingest_key_id
- [Create Ingest Key](/api/ingest_keys.md#create-ingest-key): POST /v1/projects/:project_id/sources/:source_id/ingest_keys
- [Delete Ingest Key](/api/ingest_keys.md#delete-ingest-key): DELETE /v1/projects/:project_id/sources/:source_id/ingest_keys/:ingest_key_id

## Collections

- [Collection Model](/api/collections.md#collection-model)
- [Collection Schema Report](/api/collections.md#collection-schema-report)
- [Collection Schema Proposal](/api/collections.md#collection-schema-proposal)
- [List Collections](/api/collections.md#list-collections): GET /v1/projects/:project_id/collections
- [Retrieve Collection](/api/collections.md#retrieve-collection): GET /v1/projects/:project_id/collections/:collection_id
- [Create Collection](/api/collections.md#create-collection): POST /v1/projects/:project_id/collections
- [Update Collection](/api/collections.md#update-collection): POST /v1/projects/:project_id/collections/:collection_id
- [Delete Collection](/api/collections.md#delete-collection): DELETE /v1/projects/:project_id/collections/:collection_id
- [Force Delete Collection](/api/collections.md#force-delete-collection): DELETE /v1/projects/:project_id/collections/:collection_id/force
- [List Collection Schemas](/api/collections.md#list-collection-schemas): GET /v1/projects/:project_id/collections/:collection_id/schemas
- [Update Collection Schema](/api/collections.md#update-collection-schema): POST /v1/projects/:project_id/collections/:collection_id/schemas/:schema_version_id
- [Retrieve Collection Schema Report](/api/collections.md#retrieve-collection-schema-report): GET /v1/projects/:project_id/collections/:collection_id/schema_report
- [Preview Collection Schema Rules](/api/collections.md#preview-collection-schema-rules): POST /v1/projects/:project_id/collections/:collection_id/schema_preview
- [List Collection Documents](/api/collections.md#list-collection-documents): GET /v1/projects/:project_id/collections/:collection_id/docs

## Views

- [View Model](/api/views.md#view-model)
- [View Transform Model](/api/views.md#view-transform-model)
- [View Version Model](/api/views.md#view-version-model)
- [Waiting Shape Model](/api/views.md#waiting-shape-model)
- [Shape Inspection Model](/api/views.md#shape-inspection-model)
- [Waiting Shape Hint Model](/api/views.md#waiting-shape-hint-model)
- [List Views](/api/views.md#list-views): GET /v1/projects/:project_id/views
- [Retrieve View](/api/views.md#retrieve-view): GET /v1/projects/:project_id/views/:view_id
- [Create View](/api/views.md#create-view): POST /v1/projects/:project_id/views
- [Create Join View](/api/views.md#create-join-view): POST /v1/projects/:project_id/views/join
- [Update View](/api/views.md#update-view): POST /v1/projects/:project_id/views/:view_id
- [Delete View](/api/views.md#delete-view): DELETE /v1/projects/:project_id/views/:view_id
- [Force Delete View](/api/views.md#force-delete-view): DELETE /v1/projects/:project_id/views/:view_id/force
- [List View Records](/api/views.md#list-view-records): GET /v1/projects/:project_id/views/:view_id/records
- [List Waiting Shapes](/api/views.md#list-waiting-shapes): GET /v1/projects/:project_id/views/:view_id/deferrals
- [Inspect Waiting Shape](/api/views.md#inspect-waiting-shape): GET /v1/projects/:project_id/views/:view_id/deferrals/:deferral_id
- [Retrieve Waiting Shape Hint](/api/views.md#retrieve-waiting-shape-hint): GET /v1/projects/:project_id/views/:view_id/deferrals/:deferral_id/hint
- [Decide Waiting Shape](/api/views.md#decide-waiting-shape): POST /v1/projects/:project_id/views/:view_id/deferrals/:deferral_id/decision
- [List View Transforms](/api/views.md#list-view-transforms): GET /v1/projects/:project_id/views/:view_id/transforms
- [Retrieve View Transform](/api/views.md#retrieve-view-transform): GET /v1/projects/:project_id/views/:view_id/transforms/:transform_id
- [List View Versions](/api/views.md#list-view-versions): GET /v1/projects/:project_id/views/:view_id/versions
- [Retrieve View Version](/api/views.md#retrieve-view-version): GET /v1/projects/:project_id/views/:view_id/versions/:version_id
- [Create View Transform](/api/views.md#create-view-transform): POST /v1/projects/:project_id/views/:view_id/transforms
- [Update View Transform](/api/views.md#update-view-transform): POST /v1/projects/:project_id/views/:view_id/transforms/:transform_id
- [Generate View Transform Script](/api/views.md#generate-view-transform-script): POST /v1/projects/:project_id/views/:view_id/transforms/:transform_id/generate
- [Re-backfill View Transform](/api/views.md#re-backfill-view-transform): POST /v1/projects/:project_id/views/:view_id/transforms/:transform_id/rebackfill
- [Regenerate View](/api/views.md#regenerate-view): POST /v1/projects/:project_id/views/:view_id/regenerate
- [Delete View Transform](/api/views.md#delete-view-transform): DELETE /v1/projects/:project_id/views/:view_id/transforms/:transform_id

## Metrics

- [Metric Model](/api/metrics.md#metric-model)
- [Timeseries Aggregation Model](/api/metrics.md#timeseries-aggregation-model)
- [Aggregation Series Model](/api/metrics.md#aggregation-series-model)
- [Metric Series Model](/api/metrics.md#metric-series-model)
- [List Metrics](/api/metrics.md#list-metrics): GET /v1/projects/:project_id/metrics
- [Retrieve Metric](/api/metrics.md#retrieve-metric): GET /v1/projects/:project_id/metrics/:metric_id
- [Retrieve Metric Aggregation](/api/metrics.md#retrieve-metric-aggregation): GET /v1/projects/:project_id/metrics/:metric_id/aggregation
- [Create Metric](/api/metrics.md#create-metric): POST /v1/projects/:project_id/metrics
- [Update Metric](/api/metrics.md#update-metric): POST /v1/projects/:project_id/metrics/:metric_id
- [Backfill Metric Data](/api/metrics.md#backfill-metric-data): POST /v1/projects/:project_id/metrics/:metric_id/backfill
- [Delete Metric](/api/metrics.md#delete-metric): DELETE /v1/projects/:project_id/metrics/:metric_id
- [Force Delete Metric](/api/metrics.md#force-delete-metric): DELETE /v1/projects/:project_id/metrics/:metric_id/force
- [List Metric Series](/api/metrics.md#list-metric-series): GET /v1/projects/:project_id/metrics/:metric_id/series
- [Update Metric Series](/api/metrics.md#update-metric-series): POST /v1/projects/:project_id/metrics/:metric_id/series/:series_id

## Monitors

- [Monitor Model](/api/monitors.md#monitor-model)
- [Monitor Preview Model](/api/monitors.md#monitor-preview-model)
- [Monitor Verdict Model](/api/monitors.md#monitor-verdict-model)
- [Monitor Series State Model](/api/monitors.md#monitor-series-state-model)
- [List Monitors](/api/monitors.md#list-monitors): GET /v1/projects/:project_id/monitors | GET /v1/projects/:project_id/metrics/:metric_id/monitors
- [Retrieve Monitor](/api/monitors.md#retrieve-monitor): GET /v1/projects/:project_id/metrics/:metric_id/monitors/:monitor_id
- [Create Monitor](/api/monitors.md#create-monitor): POST /v1/projects/:project_id/metrics/:metric_id/monitors
- [Preview Monitor](/api/monitors.md#preview-monitor): POST /v1/projects/:project_id/metrics/:metric_id/monitors/preview
- [Update Monitor](/api/monitors.md#update-monitor): POST /v1/projects/:project_id/metrics/:metric_id/monitors/:monitor_id
- [Pause Monitor](/api/monitors.md#pause-monitor): POST /v1/projects/:project_id/metrics/:metric_id/monitors/:monitor_id/pause
- [Resume Monitor](/api/monitors.md#resume-monitor): POST /v1/projects/:project_id/metrics/:metric_id/monitors/:monitor_id/resume
- [Delete Monitor](/api/monitors.md#delete-monitor): DELETE /v1/projects/:project_id/metrics/:metric_id/monitors/:monitor_id

## Alerts

- [Alert Model](/api/alerts.md#alert-model)
- [List Alerts](/api/alerts.md#list-alerts): GET /v1/projects/:project_id/metrics/:metric_id/alerts
- [Retrieve Alert](/api/alerts.md#retrieve-alert): GET /v1/projects/:project_id/alerts/:alert_id

## Pages

- [Page Model](/api/pages.md#page-model)
- [Page Domain Route Model](/api/pages.md#page-domain-route-model)
- [List Pages](/api/pages.md#list-pages): GET /v1/projects/:project_id/pages
- [Retrieve Page](/api/pages.md#retrieve-page): GET /v1/projects/:project_id/pages/:page_id
- [Create Page](/api/pages.md#create-page): POST /v1/projects/:project_id/pages
- [Update Page](/api/pages.md#update-page): POST /v1/projects/:project_id/pages/:page_id
- [Add Page Domain](/api/pages.md#add-page-domain): POST /v1/projects/:project_id/pages/:page_id/domains/:domain_id
- [Remove Page Domain](/api/pages.md#remove-page-domain): DELETE /v1/projects/:project_id/pages/:page_id/domains/:domain_id
- [Refresh Page URL](/api/pages.md#refresh-page-url): POST /v1/projects/:project_id/pages/:page_id/refresh
- [Delete Page](/api/pages.md#delete-page): DELETE /v1/projects/:project_id/pages/:page_id

## Components

- [Component Model](/api/components.md#component-model)
- [Add Component](/api/components.md#add-component): POST /v1/projects/:project_id/pages/:page_id/components
- [Update Component](/api/components.md#update-component): POST /v1/projects/:project_id/pages/:page_id/components/:component_id
- [Delete Component](/api/components.md#delete-component): DELETE /v1/projects/:project_id/pages/:page_id/components/:component_id

## Teams

- [Team Model](/api/teams.md#team-model)
- [Team Billing Model](/api/teams.md#team-billing-model)
- [Billing Line Item Model](/api/teams.md#billing-line-item-model)
- [Billing Estimate Model](/api/teams.md#billing-estimate-model)
- [Address Model](/api/teams.md#address-model)
- [List Teams](/api/teams.md#list-teams): GET /v1/teams
- [Retrieve Team](/api/teams.md#retrieve-team): GET /v1/teams/:team_id
- [Retrieve Team Billing](/api/teams.md#retrieve-team-billing): GET /v1/teams/:team_id/billing
- [Create Team](/api/teams.md#create-team): POST /v1/teams
- [Update Team](/api/teams.md#update-team): POST /v1/teams/:team_id
- [Delete Team](/api/teams.md#delete-team): DELETE /v1/teams/:team_id
- [List Team Members](/api/teams.md#list-team-members): GET /v1/teams/:team_id/users
- [Retrieve Team Member](/api/teams.md#retrieve-team-member): GET /v1/teams/:team_id/users/:user_id
- [Add Team Member](/api/teams.md#add-team-member): POST /v1/teams/:team_id/users
- [Update Team Member](/api/teams.md#update-team-member): POST /v1/teams/:team_id/users/:user_id
- [Remove Team Member](/api/teams.md#remove-team-member): DELETE /v1/teams/:team_id/users/:user_id

## Users

- [User Model](/api/users.md#user-model)
- [List Users](/api/users.md#list-users): GET /v1/users
- [Retrieve User](/api/users.md#retrieve-user): GET /v1/users/:user_id
- [Update User](/api/users.md#update-user): POST /v1/users/:user_id
- [Enable Password Authentication](/api/users.md#enable-password-authentication): POST /v1/users/:user_id/enable_password
- [List User Teams](/api/users.md#list-user-teams): GET /v1/users/:user_id/teams

## Roles

- [Role Model](/api/roles.md#role-model)
- [List Roles](/api/roles.md#list-roles): GET /v1/roles
- [Retrieve Role](/api/roles.md#retrieve-role): GET /v1/roles/:role_id
- [Create Role](/api/roles.md#create-role): POST /v1/roles
- [Update Role](/api/roles.md#update-role): POST /v1/roles/:role_id
- [Delete Role](/api/roles.md#delete-role): DELETE /v1/roles/:role_id

## API Keys

- [API Key Model](/api/apiKeys.md#api-key-model)
- [List API Keys](/api/apiKeys.md#list-api-keys): GET /v1/keys
- [Retrieve API Key](/api/apiKeys.md#retrieve-api-key): GET /v1/keys/:key_id
- [Create API Key](/api/apiKeys.md#create-api-key): POST /v1/keys
- [Update API Key](/api/apiKeys.md#update-api-key): POST /v1/keys/:key_id
- [Delete API Key](/api/apiKeys.md#delete-api-key): DELETE /v1/keys/:key_id

## Domains

- [Domain Model](/api/domains.md#domain-model)
- [List Domains](/api/domains.md#list-domains): GET /v1/domains
- [Retrieve Domain](/api/domains.md#retrieve-domain): GET /v1/domains/:domain_id
- [Create Domain](/api/domains.md#create-domain): POST /v1/domains
- [Check Domain DNS](/api/domains.md#check-domain-dns): POST /v1/domains/:domain_id/check
- [Update Domain](/api/domains.md#update-domain): POST /v1/domains/:domain_id
- [Delete Domain](/api/domains.md#delete-domain): DELETE /v1/domains/:domain_id

## Servers

- [Server Model](/api/servers.md#server-model)
- [Server Event Model](/api/servers.md#server-event-model)
- [List Servers](/api/servers.md#list-servers): GET /v1/projects/:project_id/servers
- [Retrieve Server](/api/servers.md#retrieve-server): GET /v1/projects/:project_id/servers/:server_id
- [Scale Servers](/api/servers.md#scale-servers): POST /v1/projects/:project_id/servers
- [Update Server](/api/servers.md#update-server): POST /v1/projects/:project_id/servers/:server_id
- [Retrieve Server Vitals](/api/servers.md#retrieve-server-vitals): GET /v1/projects/:project_id/servers/:server_id/vitals
- [Retrieve Server Pipeline](/api/servers.md#retrieve-server-pipeline): GET /v1/projects/:project_id/servers/:server_id/pipeline
- [List Server Events](/api/servers.md#list-server-events): GET /v1/projects/:project_id/servers/:server_id/events

## Drains

- [Drain Model](/api/drains.md#drain-model)
- [List Drains](/api/drains.md#list-drains): GET /v1/projects/:project_id/drains
- [Retrieve Drain](/api/drains.md#retrieve-drain): GET /v1/projects/:project_id/drains/:drain_id
- [Create Drain](/api/drains.md#create-drain): POST /v1/projects/:project_id/drains
- [Update Drain](/api/drains.md#update-drain): POST /v1/projects/:project_id/drains/:drain_id
- [Delete Drain](/api/drains.md#delete-drain): DELETE /v1/projects/:project_id/drains/:drain_id
- [Verify Drain](/api/drains.md#verify-drain): POST /v1/projects/:project_id/drains/:drain_id/verify
- [Confirm Drain Verification](/api/drains.md#confirm-drain-verification): POST /v1/projects/:project_id/drains/:drain_id/verify_confirm
- [Pause Drain](/api/drains.md#pause-drain): POST /v1/projects/:project_id/drains/:drain_id/pause
- [Resume Drain](/api/drains.md#resume-drain): POST /v1/projects/:project_id/drains/:drain_id/resume
- [Send Drain Sample](/api/drains.md#send-drain-sample): POST /v1/projects/:project_id/drains/:drain_id/sample

## Pulls

- [Pull Model](/api/pulls.md#pull-model)
- [Pull Test Result](/api/pulls.md#pull-test-result)
- [List Pulls](/api/pulls.md#list-pulls): GET /v1/projects/:project_id/pulls
- [Retrieve Pull](/api/pulls.md#retrieve-pull): GET /v1/projects/:project_id/pulls/:pull_id
- [Create Pull](/api/pulls.md#create-pull): POST /v1/projects/:project_id/pulls
- [Update Pull](/api/pulls.md#update-pull): POST /v1/projects/:project_id/pulls/:pull_id
- [Delete Pull](/api/pulls.md#delete-pull): DELETE /v1/projects/:project_id/pulls/:pull_id
- [Pause Pull](/api/pulls.md#pause-pull): POST /v1/projects/:project_id/pulls/:pull_id/pause
- [Resume Pull](/api/pulls.md#resume-pull): POST /v1/projects/:project_id/pulls/:pull_id/resume
- [Test Pull](/api/pulls.md#test-pull): POST /v1/projects/:project_id/pulls/:pull_id/test

## Checks

- [Check Model](/api/checks.md#check-model)
- [Check Test Result](/api/checks.md#check-test-result)
- [List Checks](/api/checks.md#list-checks): GET /v1/projects/:project_id/checks
- [Retrieve Check](/api/checks.md#retrieve-check): GET /v1/projects/:project_id/checks/:check_id
- [Create Check](/api/checks.md#create-check): POST /v1/projects/:project_id/checks
- [Update Check](/api/checks.md#update-check): POST /v1/projects/:project_id/checks/:check_id
- [Delete Check](/api/checks.md#delete-check): DELETE /v1/projects/:project_id/checks/:check_id
- [Pause Check](/api/checks.md#pause-check): POST /v1/projects/:project_id/checks/:check_id/pause
- [Resume Check](/api/checks.md#resume-check): POST /v1/projects/:project_id/checks/:check_id/resume
- [Test Check](/api/checks.md#test-check): POST /v1/projects/:project_id/checks/:check_id/test

## Logs

- [Log Model](/api/logs.md#log-model)
- [Auth Log Details Model](/api/logs.md#auth-log-details-model)
- [Audit Log Details Model](/api/logs.md#audit-log-details-model)
- [Billing Log Details Model](/api/logs.md#billing-log-details-model)
- [List Logs](/api/logs.md#list-logs): GET /v1/logs

## Guides

- [Concepts](/guides/concepts.md)
- [Auth](/guides/auth.md)
- [Servers](/guides/servers.md)
- [Ingest Key](/guides/ingest-key.md)
- [Sending Data](/guides/sending-data.md)
- [Sdk](/guides/sdk.md)
- [Teams](/guides/teams.md)
- [Users](/guides/users.md)
- [Projects](/guides/projects.md)
- [Sources](/guides/sources.md)
- [Records](/guides/records.md)
- [Metrics](/guides/metrics.md)
- [Pages](/guides/pages.md)
- [Custom Domains](/guides/custom-domains.md)
- [Api Keys](/guides/api-keys.md)
- [Billing](/guides/billing.md)
- [Chat](/guides/chat.md)
- [Checks](/guides/checks.md)
- [Cli](/guides/cli.md)
- [Drains](/guides/drains.md)
- [Notifications](/guides/notifications.md)
- [Pulls](/guides/pulls.md)
- [Quickstart](/guides/quickstart.md)
- [Secrets](/guides/secrets.md)
- [Tgl](/guides/tgl.md)
- [Control Flow](/guides/tgl/control-flow.md)
- [Functions](/guides/tgl/functions.md)
- [Operators](/guides/tgl/operators.md)
- [Recipes](/guides/tgl/recipes.md)
- [Syntax](/guides/tgl/syntax.md)