Report Schedule

Retrieve a single Report Schedule record by ID.

get/api/cp/report-schedule/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

account_idinteger

Account Id (references account.id)

namestring

Name

emailstring email

Email

frequency'day' | 'week' | 'month'

Frequency

queryobject

Query

Example response

{
  "id": 12345,
  "account_id": 1,
  "name": "Example Name",
  "email": "user@example.com",
  "frequency": "day",
  "query": "Sample query text content"
}

Changes

    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API