PredictLeads: Product

Get the details of one company product, given its ID.

Tool ID: predictleads_product

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(
  'predictleads_product',
  {
    "id": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute predictleads_product --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe predictleads_product --json for the complete live contract.

Input reference

Returns a single Product.

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Product’s ID. Format: `uuid`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	PredictLeads provides data on the products offered by more than 2 million companies.
`result.data.data`	`array`	Yes	—	—
`result.data.data[].id`	`string`	Yes	—	ID of the `Product` object. Format: `uuid`.
`result.data.data[].type`	`"product"`	Yes	—	Type of the `Product` object.
`result.data.data[].attributes`	`object`	Yes	—	Attributes of the `Product` object.
`result.data.data[].attributes.category`	`"product" \| "service" \| "solution" \| "unclassified"`	Yes	—	Category classified to `product`, `service` or `solution`. If the product cannot be classified, this field will be `unclassified`. Allowed: `product`, `service`, `solution`, `unclassified`.
`result.data.data[].attributes.description`	`string \| null`	Yes	—	Short description of the product.
`result.data.data[].attributes.name`	`string`	Yes	—	Name of the product.
`result.data.data[].attributes.sources`	`"menu" \| "pricing"`	Yes	—	Array of source types where the `Product` has been found on. Allowed: `menu`, `pricing`.
`result.data.data[].attributes.source_url`	`string`	Yes	—	URL where the product was found on. Format: `uri`.
`result.data.data[].attributes.first_seen_at`	`string`	Yes	—	Date & time (ISO 8601) when the `Product` was discovered. Format: `date-time`.
`result.data.data[].attributes.last_seen_at`	`string`	Yes	—	Date & time (ISO 8601) when the Product’s page was last visited. Format: `date-time`.
`result.data.data[].relationships`	`object`	Yes	—	The data contains references to related objects listed in the `included` property.
`result.data.data[].relationships.company`	`object`	Yes	—	The data contains a reference to related `CompanyLite` object listed in the `included` property.
`result.data.data[].relationships.company.data`	`object`	Yes	—	—
`result.data.data[].relationships.company.data.id`	`string`	Yes	—	ID of the included `CompanyLite` object. Format: `uuid`.
`result.data.data[].relationships.company.data.type`	`"company"`	Yes	—	Type of the included `CompanyLite` object.
`result.data.included`	`array`	Yes	—	Contains objects referenced in property `relationships`.
`result.data.included[].id`	`string`	Yes	—	ID of the `CompanyLite` object. Format: `uuid`.
`result.data.included[].type`	`"company"`	Yes	—	Type of the `CompanyLite` object.
`result.data.included[].attributes`	`object`	Yes	—	Attributes of the `CompanyLite` object.
`result.data.included[].attributes.domain`	`string`	Yes	—	Company domain name.
`result.data.included[].attributes.company_name`	`string \| null`	Yes	—	Company name if available.
`result.data.included[].attributes.ticker`	`string \| null`	Yes	—	Company stock symbol (ticker) if available.
`result.data.meta`	`object`	No	—	Meta information about `ProductsDataset` object.
`result.data.meta.schema_version`	`string`	Yes	—	Represents schema version of objects.
`result.data.meta.record_state`	`"active"`	Yes	—	Represents record state of objects.
`result.data.meta.count`	`integer`	No	—	Total number of results. NOTE: Only included in API responses when the request parameter `page` is provided, for performance reasons.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0.56 per pricing unit.

​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