Skip to content

Rippling: Trigger a report run

Rippling restApi.triggerReportRuns: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.trigger_report_runs

Provider route: POST /report-runs/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["triggerReportRuns"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.triggerReportRuns(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.trigger_report_runs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Trigger a report run — request body — body

Referenced models: Trigger a report run — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of this run
report_idstringRequired within parentThe ID of the report associated with this run
resultobjectOptionalReport data, available once the run is complete
result.expires_atstringRequired within parentThe expiry time of the execution
result.file_urlstringRequired within parentThe presigned file url
result.output_typestringRequired within parentThe type of the output file
Known values: JSON, CSV
statusstringRequired within parentReport run status
Known values: IN_PROGRESS, SUCCESS, FAILURE
Trigger a report run — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
filtersJSONOptional
filters (anyOf 1)arrayAlternativeOptional list of filters to apply when running the report
Default: null
filters (anyOf 1)[]ModelEach itemExpand Trigger a report run — request body — body filters array item
filters (anyOf 2)nullAlternative
format_currency_fieldsJSONOptional
format_currency_fields (anyOf 1)JSONAlternativeFormatting options for currency fields
Default: null
format_currency_fields (anyOf 1) (anyOf 1)objectAlternative
format_currency_fields (anyOf 1) (anyOf 1).columnsstringRequired within parentCurrency column format for currency fields
One of: TYPE_AND_AMOUNT, VALUE_ONLY
format_currency_fields (anyOf 1) (anyOf 1).currency_typeJSONOptional
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 1)stringAlternativeCurrency type (e.g., 'USD')
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 2)nullAlternative
format_currency_fields (anyOf 1) (anyOf 2)nullAlternative
format_currency_fields (anyOf 2)nullAlternative
format_date_fieldsJSONOptional
format_date_fields (anyOf 1)JSONAlternativeFormatting options for date fields
Default: null
format_date_fields (anyOf 1) (anyOf 1)objectAlternative
format_date_fields (anyOf 1) (anyOf 1).date_formatstringRequired within parentDate format for date fields in the report output
One of: ISO_8601, APPLY_VISUALIZATION_SETTINGS
format_date_fields (anyOf 1) (anyOf 1).datetime_timezoneJSONOptional
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 1)stringAlternativeTimezone for datetime fields (e.g., 'America/Los_Angeles')
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 2)nullAlternative
format_date_fields (anyOf 1) (anyOf 2)nullAlternative
format_date_fields (anyOf 2)nullAlternative
include_object_idsbooleanOptionalWhether to include object IDs in the report output
Default: false
include_total_rowsbooleanOptionalWhether to include total row count in the report output
Default: false
output_typestringOptionalOutput format for the report data
Default: JSON
One of: JSON, CSV
report_idstringRequired within parentThe ID of the report to run
view_asstringOptionalControls whose permissions are used when running the report. VIEWER (default) uses the API token owner's own permissions. OWNER uses the report owner's permissions (requires owner-level access to the report).
Default: VIEWER
One of: VIEWER, OWNER

Referenced models: Trigger a report run — request body — body filters array item

Trigger a report run — request body — body filters array item
FieldTypePresenceDescription and constraints
$objectRootA single filter to apply when running a report. The expected shape of 'value' depends on the operator — see the FilterOperator description for details.
field_idstringRequired within parentThe ID of the report field to filter on
operatorstringRequired within parentComparison operator for the filter. Single-value operators (EQ, NE, GT, GTE, LT, LTE, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, BEFORE, AFTER) require a scalar value. List operators (IN, NOT_IN) require a non-empty array. Range operators (BETWEEN, NOT_BETWEEN) require an object with 'from' and 'to' keys. No-value operators (IS_EMPTY, IS_NOT_EMPTY) do not require a value. Rolling-date operators (LAST_N, NEXT_N) require an object with 'unit' (DAY, WEEK, MONTH, YEAR) and 'n' (integer). Calendar-date operators (CURRENT_CALENDAR, PREVIOUS_CALENDAR) require a unit string (DAY, WEEK, MONTH, QUARTER, YEAR).
One of: EQ, NE, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, GT, GTE, LT, LTE, BETWEEN, NOT_BETWEEN, IS_EMPTY, IS_NOT_EMPTY, BEFORE, AFTER, LAST_N, NEXT_N, CURRENT_CALENDAR, PREVIOUS_CALENDAR
valueJSONOptional
value (anyOf 1)JSONAlternativeThe filter value. Shape depends on the operator: scalar for single-value operators; array for list operators; RangeValue object ({from, to}) for range operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit string for calendar-date operators; omitted or null for IS_EMPTY/IS_NOT_EMPTY.
value (anyOf 1) (oneOf 1)stringAlternative
value (anyOf 1) (oneOf 2)numberAlternative
value (anyOf 1) (oneOf 3)booleanAlternative
value (anyOf 1) (oneOf 4)arrayAlternative
value (anyOf 1) (oneOf 5)ModelAlternativeExpand Trigger a report run — request body — body filters array item value value from, to
value (anyOf 1) (oneOf 6)ModelAlternativeExpand Trigger a report run — request body — body filters array item value value n, unit
value (anyOf 2)nullAlternative

Referenced models: Trigger a report run — request body — body filters array item value value from, to, Trigger a report run — request body — body filters array item value value n, unit

Trigger a report run — request body — body filters array item value value from, to
FieldTypePresenceDescription and constraints
$objectRootRange bounds for 'between' and 'not_between' operators
Trigger a report run — request body — body filters array item value value n, unit
FieldTypePresenceDescription and constraints
$objectRootRolling date window for 'last_n' and 'next_n' operators

SDK function policy ID: rippling.rest_api.trigger_report_runs. Catalog operation: trigger-report-runs. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["report-runs.read-write"]

Provider entitlements: ["Reports_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.