Activities

Search activities

Returns activities ranked by relevance to a query.

post/v1/activities/search

Request

Base URL
https://api.metal.ai
Auth
API key in header x-metal-client-id and API key in header x-metal-api-key
TypeScript
https://skmtc.dev/metal/apis/metal-api/docs/v1/activities/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

querystring required

The search query.

pageinteger

Page number, starting at 1.

limitinteger

Results per page.

Example request

{
  "query": "industrial automation suppliers"
}

Response

Ranked activities results.

Example response

{
  "data": [
    {
      "subject": "Intro call with management",
      "type": "Meeting"
    }
  ],
  "metadata": {
    "page": 1,
    "limit": 20,
    "totalCount": 134,
    "totalPages": 7
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.