# Canny Public Roadmap (`fulfilled_enchilada/canny-public-roadmap`) Actor

Fetch public Canny roadmap/board posts. One company slug or public URL in. Structured posts out (title, status, score, commentCount, url, createdAt, boardName, tags).

- **URL**: https://apify.com/fulfilled\_enchilada/canny-public-roadmap.md
- **Developed by:** [Nock](https://apify.com/fulfilled_enchilada) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Canny Public Roadmap

**Unpublished / not listed on Apify Store yet.** Publisher: **Nock**.

Fetch public Canny roadmap and board posts over anonymous HTTP. One company slug or public URL in. Structured posts out.

This Actor is **not affiliated with, endorsed by, or related to Canny**. It only reads pages and JSON that a public Canny portal already serves without a login.

### What it does

Give the Actor a public company slug (`ahrefs`), a public portal URL (`https://ahrefs.canny.io`), or a public board URL (`https://feedback.canny.io/feature-requests`). It returns a dataset of public posts with an allowlisted set of fields.

No Canny API key. No login. No cookies. No voter identities, author names, emails, or avatars.

### Features

- One slug or public `*.canny.io` URL as input
- Structured posts: title, status, score, commentCount, url, createdAt, boardName, tags
- Public HTTP/JSON only
- Private and login-only boards are skipped
- Pay-per-event ready: one `post` event per public post written to the default dataset (prices are set later in Apify Console, not in this tree)

### Input

| Field | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `board` | string | yes | — | Company slug, public `*.canny.io` URL, or public board URL |
| `maxPages` | integer | no | `5` | Number of 10-item pages requested per public board |

Example:

```json
{"board":"ahrefs","maxPages":1}
```

Other accepted `board` values:

- `ahrefs`
- `https://ahrefs.canny.io`
- `https://feedback.canny.io/feature-requests`

A local example lives at `.actor/example_input.json`. The Apify CLI `apify run` path uses `storage/key_value_stores/default/INPUT.json`.

### Output

Each dataset item has **only** these fields:

| Field | Type | Source |
| --- | --- | --- |
| `title` | string or null | post title |
| `status` | string or null | e.g. `open`, `planned`, `in progress`, `complete` |
| `score` | number or null | public vote score |
| `commentCount` | number or null | public comment count |
| `url` | string or null | `https://{subdomain}.canny.io/{board}/p/{urlName}` |
| `createdAt` | string or null | ISO timestamp when the public list includes it |
| `boardName` | string or null | public board name |
| `tags` | string\[] | public tag **names** only, when present |

`tags` is often `[]`. Public list JSON frequently omits tag names.

### What is collected

- Public post title, status, score, comment count, URL, created time, board name, tag names

### What is not collected

- Author names, author IDs, `author`, `authorID`, `by`
- Voters, voter identities, emails, avatars
- Private or login-only boards (`settings.access` other than `public`)
- Empty boards
- Posts marked `notAuthorized`

### How to run on Apify

This Actor is **not published and not listed**. After a later upload to an Apify account (not done from this tree):

1. Open the Actor in Apify Console.
2. Set input to a public slug such as ahrefs, or another public slug/URL.
3. Run. Results land in the default dataset.

Do not publish until you have reviewed store listing, icon, and monetization.

### How to run locally

Requires Node.js 18+. From this directory, install the listed package.json dependencies, then run scrape.js with a board slug such as ahrefs and optional --max-pages 1.

You can also pass a public portal URL or a public board URL. The CLI path prints JSON to stdout and writes the default local dataset under `storage/datasets/default`.

If the Apify CLI is present, `apify run` uses `storage/key_value_stores/default/INPUT.json`.

### Public HTTP endpoints

Anonymous POST with a JSON body. No cookies and no API key.

- List public boards: `https://{subdomain}.canny.io/api/boards/getAll` with body `{}`
- List public posts: `https://{subdomain}.canny.io/api/posts/get` with a pages count and optional boardURLNames
- Public roadmap (optional): `https://{subdomain}.canny.io/api/roadmap/get` with a pages count

Company-level runs also try the optional roadmap endpoint and merge any extra public posts. Private/login boards are skipped.

### Pricing (pay-per-event, not priced in this tree)

The Actor is wired for pay-per-event. Do not invent prices. Configure events in Apify Console when you monetize:

- `apify-actor-start`: synthetic platform event charged automatically when a run starts. Do not charge this event from code.
- `post`: one event per public post written to the default dataset via Actor.pushData with event name post.

Set prices, free-event allowances, and whether `apify-default-dataset-item` is enabled in Console. This repository does not include a price list.

### Limits

- Public HTTP/JSON only. No browser automation, no captcha solving, no login.
- Public boards only. Private or login-gated portals are skipped.
- Pagination is pages = number of 10-post pages. Large boards need a higher maxPages.
- This tree is unpublished and not listed. Upload and store publication are separate later steps.

### FAQ

**Is this an official Canny tool?** No. Nock publishes this Actor independently. It is not affiliated with Canny.

**Do I need a Canny API key?** No. The Actor only calls public HTTP endpoints.

**Will I get voter or author data?** No. Those fields are stripped. Output is an allowlist.

### License

UNLICENSED. Unpublished Actor source for Nock.

### Later upload (not performed here)

When you are ready, authenticate the Apify CLI on your machine, then run the CLI push command from this directory. That creates or updates the unpublished Actor on your account. Publishing to the Store is a separate Console step.

# Actor input Schema

## `board` (type: `string`):

Company slug (for example ahrefs), public portal URL (https://ahrefs.canny.io), or public board URL (https://feedback.canny.io/feature-requests).

## `maxPages` (type: `integer`):

Number of 10-item pages to request per public board. Increase for large boards.

## Actor input object example

```json
{
  "board": "ahrefs",
  "maxPages": 5
}
```

# Actor output Schema

## `posts` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "board": "ahrefs",
    "maxPages": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("fulfilled_enchilada/canny-public-roadmap").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "board": "ahrefs",
    "maxPages": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("fulfilled_enchilada/canny-public-roadmap").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "board": "ahrefs",
  "maxPages": 5
}' |
apify call fulfilled_enchilada/canny-public-roadmap --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,fulfilled_enchilada/canny-public-roadmap"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/a2jgbJhI9XZW6esyC/builds/AZdxbuOciOuSJebrq/openapi.json