> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/api-reference/tracr-api/references/reporting.md).

# Reporting

## Get Diamond Unlock Records

> Return all diamond unlock records matching the filters defined by the query parameters.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.36.1"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/reporting/unlocked":{"get":{"description":"Return all diamond unlock records matching the filters defined by the query parameters.","operationId":"get_diamond_unlock_records_reporting_unlocked_get","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Page number","minimum":1,"title":"Page","type":"integer"}},{"in":"query","name":"size","required":false,"schema":{"default":100,"maximum":1000,"minimum":1,"title":"Size","type":"integer"}},{"description":"Search for a diamond unlock record by its diamond_id or participant_id.","in":"query","name":"search","required":false,"schema":{"description":"Search for a diamond unlock record by its diamond_id or participant_id.","title":"Search","type":"string"}},{"description":"Filter to unlock records for diamonds that were unlocked on or after the specified date and time.","in":"query","name":"unlocked_at__gte","required":false,"schema":{"description":"Filter to unlock records for diamonds that were unlocked on or after the specified date and time.","format":"date-time","title":"Unlocked At  Gte","type":"string"}},{"description":"Filter to unlock records for diamonds that were before the specified date and time.","in":"query","name":"unlocked_at__lt","required":false,"schema":{"description":"Filter to unlock records for diamonds that were before the specified date and time.","format":"date-time","title":"Unlocked At  Lt","type":"string"}},{"in":"query","name":"order_by","required":false,"schema":{"default":"-unlocked_at,diamond_id","title":"Order By","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockReportListResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized:  The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden:  The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get Diamond Unlock Records","tags":["Reporting"]}}},"components":{"schemas":{"UnlockReportListResponse":{"description":"A paginated response containing zero or more diamond unlock records.","properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page.","title":"Next"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the current page.","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"The total number of pages.","title":"Pages"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL of the previous page.","title":"Previous"},"results":{"description":"The results for the current page.","items":{"$ref":"#/components/schemas/UnlockReportResponse"},"title":"Results","type":"array"},"total":{"description":"The total number of results across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"UnlockReportListResponse","type":"object"},"UnlockReportResponse":{"description":"A single diamond unlock record.","properties":{"carat_range":{"title":"Carat Range","type":"string"},"carat_weight":{"title":"Carat Weight","type":"string"},"diamond_id":{"title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Participant Id"},"unit_price":{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d{0,2}0*$","title":"Unit Price","type":"string"},"unlocked_at":{"format":"date-time","title":"Unlocked At","type":"string"}},"required":["diamond_id","unlocked_at","carat_range","carat_weight","unit_price"],"title":"UnlockReportResponse","type":"object"}}}}
```

## Export Diamond Unlock Records

> Export all diamond unlock records matching the filters defined by the query parameters as an excel spreadsheet.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.36.1"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/reporting/unlocked/export":{"get":{"description":"Export all diamond unlock records matching the filters defined by the query parameters as an excel spreadsheet.","operationId":"export_diamond_unlock_records_reporting_unlocked_export_get","parameters":[{"description":"Search for a diamond unlock record by its diamond_id or participant_id.","in":"query","name":"search","required":false,"schema":{"description":"Search for a diamond unlock record by its diamond_id or participant_id.","title":"Search","type":"string"}},{"description":"Filter to unlock records for diamonds that were unlocked on or after the specified date and time.","in":"query","name":"unlocked_at__gte","required":false,"schema":{"description":"Filter to unlock records for diamonds that were unlocked on or after the specified date and time.","format":"date-time","title":"Unlocked At  Gte","type":"string"}},{"description":"Filter to unlock records for diamonds that were before the specified date and time.","in":"query","name":"unlocked_at__lt","required":false,"schema":{"description":"Filter to unlock records for diamonds that were before the specified date and time.","format":"date-time","title":"Unlocked At  Lt","type":"string"}},{"in":"query","name":"order_by","required":false,"schema":{"default":"-unlocked_at,diamond_id","title":"Order By","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"},"401":{"description":"Unauthorized:  The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden:  The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Export Diamond Unlock Records","tags":["Reporting"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tracr.com/api-reference/tracr-api/references/reporting.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
