Getting Started

Sections

Theme switcher

AI Outreach

Header Parameters

api-keystring

Body Parameters

companystring Required

Recipient's company name or domain.

recipient_namestring

Recipient name to personalize the outreach email.

Nullable:
True
recipient_titlestring

Recipient title to personalize the outreach email.

Nullable:
True
recipient_emailstring

Recipient email address to send the outreach email.

Nullable:
True
preferred_metricsstring

Preferred metrics to highlight in the outreach email.

Nullable:
True
countrystring

Country code to tailor the outreach email.

Nullable:
True
languagestring

Language code for the outreach email.

Nullable:
True
emails_numberinteger

Number of outreach emails to generate.

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
granularitystring

Time granularity for the returned values

Enum values:
dailyweeklymonthly
start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

Nullable:
True
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

Nullable:
True

Response

200
Object
Success

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

Show child attributes

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot