API docs by Redocly

GS Stream Digest Public API (1.0.0)

Download OpenAPI specification:

URL: https://grand-shooting.com License: MIT

Public API to access Grand Shooting event digest data.

Authentication

All requests require an API key. You can obtain an API key from the admin dashboard.

Include your API key in the X-API-Key header or Authorization: Bearer <key>:

curl -H "X-API-Key: gs_live_xxxxxxxxxxxx" \
  https://digest-api.grand-shooting.com/api/v1/digests

Rate Limiting

The API is limited to 100 requests per minute per API key.

Scoping

API keys can be scoped to a specific accountId. If your key is scoped, you will only see resources associated with that account.

Digests

Operations on email digests

List all digests

Returns the complete list of digests configured for your account

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "digests": [
    ],
  • "count": 2
}

Get a specific digest

Returns complete details of a digest by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: digest-123

Digest ID

Responses

Response samples

Content type
application/json
{
  • "id": "digest-123",
  • "name": "Daily Events Digest",
  • "description": "Daily summary of stream events",
  • "schedule": "0 9 * * *",
  • "isActive": true,
  • "accountId": "account-789",
  • "templateId": "template-456",
  • "eventFilters": {
    },
  • "recipients": [
    ],
  • "createdAt": "2024-01-15T08:00:00.000Z",
  • "updatedAt": "2024-01-20T10:30:00.000Z"
}

Templates

Operations on email templates

List all templates

Returns the list of available email templates

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ],
  • "count": 1
}

Statistics

Statistics and metrics

Get statistics

Returns digest usage statistics for the last 30 days.

Statistics include:

  • Total number of digest executions
  • Execution success rate
  • Number of emails sent
  • Delivery rate
Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "period": "last_30_days",
  • "runs": {
    },
  • "emails": {
    }
}