maproulette / maproulette/maproulette-frontend

Make `api/v2/data/challenge` public

Open
#2,571 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
167
Forks
39
Avg merge
16h 34m
Merged PRs (30d)
11

Description

I am looking for a way to display the detailed progress of a challenge on my campaign website.

The best API I found to get the data that is used on the challenge dashboard in MR is https://maproulette.org/api/v2/data/challenge/ID

Question: Is this true or is there a different API that I can use?

There are two issues with the /data/challenge/ID API:


Issue 1: It is private and requires an apiKey to work.
This is very unfortunate, because it means I have to build workarounds to get this data to show it in a public environment. We cannot just use our MapRoulette API Key in a public JavaScript app, though, so we need to build a proxy on some server – which is what I did for now.

The API, however, does not expose any personal or sensitive data, its just numbers.

==> Please make this API endpoint public (no apiKey required)

This is the data that the Endpoint returns:

z.array(
  z.strictObject({
    id: z.number(),
    name: z.string(),
    actions: z.object({
      total: z.number(),
      available: z.number(),
      fixed: z.number(),
      falsePositive: z.number(),
      skipped: z.number(),
      deleted: z.number(),
      alreadyFixed: z.number(),
      tooHard: z.number(),
      answered: z.number(),
      validated: z.number(),
      disabled: z.number(),
      avgTimeSpent: z.number(),
      tasksWithTime: z.number(),
    }),
  }),
)

Issue 2: Missing documentation
I was not able to find any documentation of this API endpoint at https://maproulette.org/docs/swagger-ui/index.html#/Follow

==> Please add it to the docs, so its easier to find

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the /api/v2/data/challenge/ID endpoint and its authentication behavior, then compare it with the Swagger UI at https://maproulette.org/docs/swagger-ui/index.html#/Follow. Done means the endpoint works without an apiKey for the listed non-sensitive data and the endpoint is documented there.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.