go-trailhead-leaderboard-api

KO | EN

gitlite — search

#python #react #ai #go #golang #android #rust #deep-learning #linux #docker #macos #java #awesome-list #open-source

go-trailhead-leaderboard-api

(★ 11)

A Golang app that returns public Trailhead data

go-trailhead-leaderboard-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Trailhead Leaderboard API

A [Golang](https://go.dev) app that makes callouts to `trailblazer.me/` and retrieves Trailblazer User data which can then be used in other applications.

> 🚨 Note: In order to retrieve data for a specific Trailhead User, they must have their profile set to public.

Trailhead changes their services occasionally so this can break at any time!

## Installation

If you have Go [installed](https://golang.org/doc/install), you can run it locally by using the `run` command on `main.go`.

```bash
$ go run main.go
```

## Endpoints

This app has a few different endpoints for accessing public Trailhead data.

### Profile Data

```text
/trailblazer/matruff/profile
```

This endpoint returns public profile information found on trailblazer.me like "about me", company info, name, and profile/banner photos. [Example](https://go-trailhead-leaderboard-api.herokuapp.com/trailblazer/matruff/profile)

### Badge Data

This endpoint returns badges earned by the Trailblazer. The basic call without any options only gives a max of 8 at a time, representing your most recently earned badges.

```text
/trailblazer/matruff/badges
```

You can also filter badges by sending a string at the end of the URL without or without optional count. Possible filter values are: all, module, superbadge, event, and project. [Example](https://go-trailhead-leaderboard-api.herokuapp.com/trailblazer/matruff/badges/superbadge)

```text
/trailblazer/matruff/badges/superbadge
```

```text
/trailblazer/matruff/badges/all/24
```

The GraphQl endpoint returns a `pageInfo` record in the response that you can use to query for additional pages past the first count you provide. For example, in your first response for a coutn of 16 you'll get the `endCursor` value to use in your next callout to get the page after it. Pass that at the end of the API endpoint and you'll get the next 16 results. The response also tells you if there is a next page.

`pageInfo` response example:

```json
"pageInfo": {
    "__typename": "PageInfo",
    "endCursor": "eyJzIjoiMDI2NmQzOGEtZjc1MS0zOTEwLTQ0NGItOW[...]",
    "hasNextPage": true,
    "startCursor": "eyJzIjoiMDI5YWQzNjItYWQ0Mi0yOTY0LWNlMTMt[...]",
    "hasPreviousPage": false
}
```

Using `endCursor` as `after`:

```text
/trailblazer/matruff/badges/all/16/24eyJzIjoiMDI2NmQzOGEtZjc1MS0aOTEwLItOWU4MzRx[...]
```

### Certifications Data

```text
/trailblazer/matruff/certifications
```

This endpoint returns Certifications the Trailblazer has achieved. [Example](https://go-trailhead-leaderboard-api.herokuapp.com/trailblazer/matruff/certifications)

## Special Thanks

Thanks to both [@Patlatus](https://github.com/Patlatus/Salesforce-Trailhead-Api-Hack) and [@krankekatze](https://github.com/krankekatze/trailhead-batch) for the inspiration to build this. Check out their repos for related solutions.

go-trailhead-leaderboard-api

go-trailhead-leaderboard-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

go-trailhead-leaderboard-api

go-trailhead-leaderboard-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README