Reo.dev Write API: Reo Write Add Product Usage Aggregate

Send a pre-counted product usage total for a company domain or one user to Reo.dev.

Tool ID: reo_write_add_product_usage_aggregate

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'reo_write_add_product_usage_aggregate',
  {
    "payload": {
      "mode": "DOMAIN",
      "source": "PRODUCT_CLOUD",
      "activity_type": "example",
      "count": 123,
      "event_at": 123,
      "product_id": "product_123"
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline run reo_write_add_product_usage_aggregate --input '{
  "payload": {
    "mode": "DOMAIN",
    "source": "PRODUCT_CLOUD",
    "activity_type": "example",
    "count": 123,
    "event_at": 123,
    "product_id": "product_123"
  }
}'

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "response_code": "example",
    "response": "example",
    "status": "example"
  }
}

Use deepline describe reo_write_add_product_usage_aggregate --json for the latest machine-readable contract.

Input reference

Overview Sends a pre-aggregated usage count from your cloud product. Two modes: `DOMAIN` aggregates usage at the company level, `USER` aggregates it at the individual user level. ### Path Parameters None. ### Errors | Code | When it happens | Response body | |---|---|---| | 400 | API key wrong or missing · `mode` isn’t `DOMAIN` or `USER` | Bad key: `{"response_code":400,"response":"Authentication Failure","status":"failure"}` · Invalid mode: `{"response_code":400,"response":"Invalid mode. Supported modes: DOMAIN, USER","status":"failure"}` | ### ENUMs | Field | Value | Meaning | |---|---|---| | mode | `DOMAIN` | Count is for a whole company. Reo maps it to the Account | | mode | `USER` | Count is for one user. Reo maps it to the Developer, then the Account | | source | `PRODUCT_CLOUD` | Usage event from your cloud product | | user_id_type | `EMAIL` | `user_id` is an email | | See the live schema below for the complete notes.

Name	Type	Required	Default	Details
`payload.payload`	`object`	Yes	—	Wrapper object. Every field sits inside it.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.response_code`	`string`	No	—	Status code, as a string.
`result.data.response`	`string`	No	—	Result message.
`result.data.status`	`string`	No	—	`success` or `failure`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation