Outreach report

Reports API · reports.outreach

URL · Fields · Example · Response · Try it

URL and authentication

POST https://YOUR-BACKEND/api/automation/v1/execute

Send Authorization: Bearer <connection key>, Accept: application/json and Content-Type: application/json. Create a connection.

This operation requires read access and CRM permission view_outreach_report. The gateway invokes GET /api/v1/app/reports/workspace/outreach internally. Use the POST URL above with your automation key, including for read and delete operations.

Request parameters

Fields

Use a period OR explicit from_date/to_date, not both. The default is the last 30 days. Timezone defaults to the user, then company, then UTC. Date range must be less than 10 years. Automation reports return 25 rows per table regardless of per_page. Supply table and page to page that table. detail_level summary is applied only by MCP, not this gateway. format does not export a file here. A metric must match the selected table.

Fields below belong inside data. Dot paths describe nested objects; * means each array item. nullable permits null and sometimes validates a supplied field. in: lists allowed values; min: and max: limit the value, length or item count. exists: and exists_in_company: require a valid record ID. Conditional rules such as required_if and required_with refer to other fields in the same payload. Use YYYY-MM-DD for date-only values and timestamps with timezone offsets for follow-ups.

Example request

Replace the example IDs and values with records in your installation. Supply any additional custom fields required by your company.

{
  "operation": "reports.outreach",
  "data": {
    "period": "last_30_days",
    "comparison": "previous_period"
  }
}

Response

Returns the selected report in data, including metrics and tables. Each table includes rows, total, page, per_page and last_page. Automation returns 25 rows per table; use data.table and data.page in the next request to retrieve more rows.

The gateway preserves the underlying HTTP status and JSON body. Successful requests return HTTP 200. A response may also include localized message fields.

Errors

Validation failures may return message / errors, or an error string with an optional fields array. The tester shows the actual HTTP status and full body. Read about limits and retries.

Try it

curl --request POST 'https://crm.example.com/api/automation/v1/execute' \
  --header "Authorization: Bearer $BRIXIT_CONNECTION_KEY" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "operation": "reports.outreach",
  "data": {
    "period": "last_30_days",
    "comparison": "previous_period"
  }
}'