Run now

POST

https://api.sureshake.com/v2/reporter/report-schedules/{id}/run-now

Path parameters

id
string
required
format: uuid

Request body JSON

periodStart
optional
string
pattern: ^\d{4}-\d{2}-\d{2}$
periodEnd
optional
string
pattern: ^\d{4}-\d{2}-\d{2}$

Returns

202

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- scheduleId
  string
  required
  format: uuid
- trigger
  scheduled
  or
  manual
  required
- periodStart
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- periodEnd
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- scheduledFor
  string
  required
  format: date-time
- reportRunId
  string
  or null
  required
  format: uuid
- reportRunStatus
  queued
  or
  running
  or
  overdue
  or
  succeeded
  or
  failed
  or null
  required
- status
  queued
  or
  running
  or
  succeeded
  or
  failed
  required
- outputUri
  string
  or null
  required
- publishedReportId
  string
  or null
  required
  format: uuid
- error
  string
  or null
  required
- distributionStatus
  not_requested
  or
  pending
  or
  sent
  or
  partial
  or
  failed
  required
- deliveries
  array of
  object
  required
  channel
  viewer_group
  or
  email
  required
  target
  string
  required
  minLength: 1
  status
  sent
  or
  failed
  required
  detail
  string
  or null
  required
  recordedAt
  string
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Run now

curl --request POST \
  --url 'https://api.sureshake.com/v2/reporter/report-schedules/<id>/run-now' \
  --header 'Content-Type: application/json' \
  --data '{}'

const url = 'https://api.sureshake.com/v2/reporter/report-schedules/<id>/run-now';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/reporter/report-schedules/<id>/run-now"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
    "trigger": "scheduled",
    "periodStart": "string",
    "periodEnd": "string",
    "scheduledFor": "2019-08-24T14:15:22Z",
    "reportRunId": "f4a11d1c-8da3-4ee0-abdd-af00e260f7bd",
    "reportRunStatus": "queued",
    "status": "queued",
    "outputUri": "string",
    "publishedReportId": "64593163-21d4-4e74-943d-7ee8399ac5ef",
    "error": "string",
    "distributionStatus": "not_requested",
    "deliveries": [
      {
        "channel": "viewer_group",
        "target": "string",
        "status": "sent",
        "detail": "string",
        "recordedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}