This page documents the canonical HTTP contract for this endpoint.
Every post reference must identify a LinkedIn activity or share. At most 12 posts can be included. This uses connected LinkedIn read access and requires search:run plus linkedin:read on developer API keys.
The operation definition reports connected LinkedIn read with no Autotouch source credits; read the returned pricing_rule and credits_used.
The common response envelope contains items, total_found, billable_results, credits_used, pricing_rule, and metadata. Result item fields depend on this search family.
Body parameters
postsrequiredarray<LinkedInPostReference>
Required 1–12 posts; each item must contain a valid post_id or post_url.
engagement_types· optionalarray<string>
comments, reactions, or both. Default: both.
limit_per_type· optionalinteger
Per-post limit per engagement type; default 20, range 1–25.
| Name | Type | Description |
|---|---|---|
| postsrequired | array<LinkedInPostReference> | Required 1–12 posts; each item must contain a valid post_id or post_url. |
| engagement_types | array<string> | comments, reactions, or both. Default: both. |
| limit_per_type | integer | Per-post limit per engagement type; default 20, range 1–25. |
Definitions
LinkedInPostReference
Each post must resolve to an activity/share ID from post_id or a LinkedIn post_url. Extra fields are rejected.
Fields
post_id· optionalstring|null
Optional ID, maximum 300 characters.
post_url· optionalstring|null
Optional LinkedIn URL, maximum 1,000 characters.
post_text· optionalstring|null
Optional post text, maximum 20,000 characters.
author_name· optionalstring|null
Optional author name, maximum 300 characters.
author_public_identifier· optionalstring|null
Optional public identifier, maximum 300 characters.
source_query· optionalstring|null
Optional source query, maximum 500 characters.
source_company_page· optionalstring|null
Optional company-page URL or slug, maximum 1,000 characters.
| Name | Type | Description |
|---|---|---|
| post_id | string|null | Optional ID, maximum 300 characters. |
| post_url | string|null | Optional LinkedIn URL, maximum 1,000 characters. |
| post_text | string|null | Optional post text, maximum 20,000 characters. |
| author_name | string|null | Optional author name, maximum 300 characters. |
| author_public_identifier | string|null | Optional public identifier, maximum 300 characters. |
| source_query | string|null | Optional source query, maximum 500 characters. |
| source_company_page | string|null | Optional company-page URL or slug, maximum 1,000 characters. |
Errors
| Status | Meaning |
|---|---|
| 400 | The search command or provider rejected the request. |
| 401 | Authentication is required. |
| 402 | Insufficient credits for this search. |
| 403 | Developer API key lacks required scope: search:run + linkedin:read. |
| 422 | A request field is missing, outside its allowed range, or fails the typed request contract. |
