Growth tools

11 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Calculate results: Appointment outcomes

growth_tools.appointment_show_rate_calculatorread

For this tool, gross show rate is attended appointments divided by all scheduled appointments in a completed cohort. Adjusted show rate divides attended appointments by scheduled appointments after removing canceled and rescheduled bookings. Label the denominator when sharing either figure. Uses only supplied values and illustrative defaults; free, with no provider charges, account writes or messages. Returns the same results as /tools/appointment-show-rate-calculator.

Parameters

Field	Type	Required	Description
scheduled	integer	optional	Original appointment slots in a completed reporting cohort; exclude future or unresolved slots. Default: 100. Range: 0 to 10000000. Default: 100
attended	integer	optional	Original slots that were attended. Default: 75. Range: 0 to 10000000. Default: 75
canceled	integer	optional	Original slots canceled without being counted as rescheduled. Default: 10. Range: 0 to 10000000. Default: 10
rescheduled	integer	optional	Original slots moved to a different time; exclude these from canceled and attended. Default: 5. Range: 0 to 10000000. Default: 5

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.appointment_show_rate_calculator \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduled": 100,
    "attended": 75
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_appointment_show_rate_calculator at https://app.chirply.io/api/mcp, same bearer token, same input.

Calculate results: Funnel conversion

growth_tools.conversion_rate_calculatorread

Divide the number reaching the next stage by the number entering the stage, then multiply by 100. Overall conversion uses the original visitor count. Use the same cohort and observation window for every count so the rates describe one customer journey. Uses only supplied values and illustrative defaults; free, with no provider charges, account writes or messages. Returns the same results as /tools/conversion-rate-calculator.

Parameters

Field	Type	Required	Description
visitors	integer	optional	Unique visitors in the selected cohort and window. Default: 1000. Range: 0 to 10000000. Default: 1000
leads	integer	optional	Visitors in that cohort who became leads; at most the visitor count. Default: 100. Range: 0 to 10000000. Default: 100
qualified	integer	optional	Leads meeting your documented qualification rule; at most the lead count. Default: 40. Range: 0 to 10000000. Default: 40
customers	integer	optional	Qualified leads becoming customers; at most the qualified count. Default: 10. Range: 0 to 10000000. Default: 10

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.conversion_rate_calculator \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "visitors": 1000,
    "leads": 100
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_conversion_rate_calculator at https://app.chirply.io/api/mcp, same bearer token, same input.

Read tool instructions

growth_tools.describeread

Read a tool's exact fields, defaults, formulas, examples and interpretation notes. The returned defaults reproduce Reset example in the browser. Read-only and free; leaves CRM records unchanged.

Parameters

Field	Type	Required	Description
slug	string	required	Exact public tool slug returned by growth_tools.list; for example conversion-rate-calculator.

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.describe \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example"
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_describe at https://app.chirply.io/api/mcp, same bearer token, same input.

Calculate results: Email campaign metrics

growth_tools.email_metrics_calculatorread

Delivery rate uses delivered messages divided by sent messages. This tool's open and click rates use unique openers and unique clickers divided by delivered messages. Use one completed cohort and consistent provider definitions. Recorded opens and clicks can include automated activity. Uses only supplied values and illustrative defaults; free, with no provider charges, account writes or messages. Returns the same results as /tools/email-metrics-calculator.

Parameters

Field	Type	Required	Description
sent	integer	optional	Messages sent in one completed cohort. Default: 1000. Range: 0 to 10000000. Default: 1000
delivered	integer	optional	Messages reported as delivered for that cohort; at most sent messages. Default: 980. Range: 0 to 10000000. Default: 980
opens	integer	optional	Recipients with at least one recorded open; at most delivered messages. Use unique counts, not total events. Default: 392. Range: 0 to 10000000. Default: 392
clicks	integer	optional	Recipients with at least one recorded click; at most delivered messages. Clickers may exceed tracked openers. Default: 49. Range: 0 to 10000000. Default: 49

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.email_metrics_calculator \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "sent": 1000,
    "delivered": 980
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_email_metrics_calculator at https://app.chirply.io/api/mcp, same bearer token, same input.

Read definition and example

growth_tools.explainread

Return one public glossary definition, example, practical explanation and related references. Read-only and free; leaves all account records unchanged.

Parameters

Field	Type	Required	Description
slug	string	required	Exact glossary slug returned by growth_tools.glossary; for example marketing-attribution.

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.explain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example"
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_explain at https://app.chirply.io/api/mcp, same bearer token, same input.

Download results CSV

growth_tools.exportread

Return CSV text, filename and MIME type containing a tool's validated inputs, results, formulas and interpretation notes. Free and read-only; the caller saves the returned text to a file. Does not upload files, contact people or change CRM data.

Parameters

Field	Type	Required	Description
slug	string	required	Exact public tool slug returned by growth_tools.list; for example conversion-rate-calculator.
values	map of string → object	required	Tool input field IDs and values, using the names, units and accepted ranges returned by growth_tools.describe. Required fields must be supplied. Unknown fields are ignored.

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.export \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example",
    "values": {}
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_export at https://app.chirply.io/api/mcp, same bearer token, same input.

Calculate results: Follow-up capacity

growth_tools.follow_up_capacity_calculatorread

Multiply leads by planned touches per lead and average minutes per touch, then divide by 60. Compare those required hours with the team's available follow-up hours for the same period. Include preparation and logging in handling time when those tasks use the allocated hours. Uses only supplied values and illustrative defaults; free, with no provider charges, account writes or messages. Returns the same results as /tools/follow-up-capacity-calculator.

Parameters

Field	Type	Required	Description
leads	integer	optional	Lead count for your chosen day, week or month; use the same period for available hours. Default: 100. Range: 0 to 10000000. Default: 100
touches	number	optional	Planned average touches per lead, greater than zero. Averages may be fractional. Default: 3. Range: 0.01 to 1000. Default: 3
minutes	number	optional	Average handling time including preparation and logging if those consume the allocated time. Default: 5. Range: 0.01 to 1440. Default: 5
hours	number	optional	Total hours the team can allocate to follow-up in this same period. Default: 30. Range: 0 to 1000000. Default: 30

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.follow_up_capacity_calculator \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "leads": 100,
    "touches": 3
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_follow_up_capacity_calculator at https://app.chirply.io/api/mcp, same bearer token, same input.

Browse CRM glossary

growth_tools.glossaryread

List public CRM and marketing definitions with page links. Read-only and free; contains editorial reference information and no account data.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.glossary \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool growth_tools_glossary at https://app.chirply.io/api/mcp, same bearer token, same input.

Browse free tools

growth_tools.listread

List Chirply's public planning calculators and campaign URL builder. Read-only and free; no provider calls, account writes or customer messages.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool growth_tools_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Calculate results: Sales pipeline model

growth_tools.sales_pipeline_calculatorread

Multiply opportunities by average deal value and the win-rate assumption, then divide by average sales-cycle days. The result is a model of value per day. It depends on a consistent opportunity cohort and your assumptions; actual close dates and revenue can differ. Uses only supplied values and illustrative defaults; free, with no provider charges, account writes or messages. Returns the same results as /tools/sales-pipeline-calculator.

Parameters

Field	Type	Required	Description
opportunities	integer	optional	Number of opportunities in this scenario. Default: 40. Range: 0 to 10000000. Default: 40
dealValue	number	optional	Value per opportunity in one currency of your choice; the output uses that same currency. Default: 2500. Range: 0 to 1000000000. Default: 2500
winRate	number	optional	Estimated percentage of these opportunities that become wins, from 0 to 100. Default: 25. Range: 0 to 100. Default: 25
cycleDays	number	optional	Average elapsed days for a comparable cohort, greater than zero. Default: 30. Range: 0.01 to 36500. Default: 30

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.sales_pipeline_calculator \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "opportunities": 40,
    "dealValue": 2500
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_sales_pipeline_calculator at https://app.chirply.io/api/mcp, same bearer token, same input.

Build campaign URL

growth_tools.utm_builderread

Add consistent source, medium and campaign parameters to a landing-page URL. Use content and term when you need an extra distinction. This builder encodes those values, replaces matching UTM parameters and preserves unrelated parameters and the page fragment. Your analytics setup determines how visits are recorded. Uses only supplied values and illustrative defaults; free, with no provider charges, account writes or messages. Returns the same results as /tools/utm-builder.

Parameters

Field	Type	Required	Description
url	string	optional	Full HTTP or HTTPS landing-page address, up to 2,000 characters. Use a public destination without embedded credentials or personal information. Default: https://example.com/demo. Default: "https://example.com/demo"
source	string	optional	Publisher or referring source; keep spelling consistent. Up to 200 characters. Default: newsletter. Default: "newsletter"
medium	string	optional	Channel label, such as email or social. Up to 200 characters. Default: email. Default: "email"
campaign	string	optional	A consistent campaign identifier. Up to 200 characters. Default: autumn-demo. Default: "autumn-demo"
content	string	optional	Optional label for the specific link or creative. Blank removes an existing utm_content value. Default: hero-link. Default: "hero-link"
term	string	optional	Optional keyword label. Blank removes an existing utm_term value. Default: blank. Default: ""

Example

curl -X POST https://app.chirply.io/api/v1/actions/growth_tools.utm_builder \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/demo",
    "source": "newsletter"
  }'

Test with your API key

Over MCP the same operation is the tool growth_tools_utm_builder at https://app.chirply.io/api/mcp, same bearer token, same input.