{ "opencollection": "1.0.0", "info": { "name": "PostHog actions alerts API", "version": "1.0.0" }, "items": [ { "info": { "name": "alerts", "type": "folder" }, "items": [ { "info": { "name": "environments_alerts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "checks_date_from", "value": "", "type": "query", "description": "Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns checks created after this time. Max retention is 14 days." }, { "name": "checks_date_to", "value": "", "type": "query", "description": "Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if not specified." }, { "name": "checks_limit", "value": "", "type": "query", "description": "Maximum number of check results to return (default 5, max 500). Applied after date filtering." }, { "name": "checks_offset", "value": "", "type": "query", "description": "Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/simulate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created." }, { "info": { "name": "alerts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/alerts/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "alerts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/alerts/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "alerts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "checks_date_from", "value": "", "type": "query", "description": "Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns checks created after this time. Max retention is 14 days." }, { "name": "checks_date_to", "value": "", "type": "query", "description": "Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if not specified." }, { "name": "checks_limit", "value": "", "type": "query", "description": "Maximum number of check results to return (default 5, max 500). Applied after date filtering." }, { "name": "checks_offset", "value": "", "type": "query", "description": "Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "alerts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "alerts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "alerts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "alerts_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/alerts/simulate/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created." } ] } ], "bundled": true }