{"id":35619760,"url":"https://github.com/scieloorg/scielo-sushi-api","last_synced_at":"2026-01-05T06:04:12.745Z","repository":{"id":42654121,"uuid":"315758111","full_name":"scieloorg/scielo-sushi-api","owner":"scieloorg","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-05T05:16:44.000Z","size":1149,"stargazers_count":0,"open_issues_count":6,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-05T06:20:46.583Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scieloorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-24T21:36:37.000Z","updated_at":"2022-01-06T17:20:07.000Z","dependencies_parsed_at":"2024-08-16T09:03:45.170Z","dependency_job_id":null,"html_url":"https://github.com/scieloorg/scielo-sushi-api","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/scieloorg/scielo-sushi-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scieloorg%2Fscielo-sushi-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scieloorg%2Fscielo-sushi-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scieloorg%2Fscielo-sushi-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scieloorg%2Fscielo-sushi-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scieloorg","download_url":"https://codeload.github.com/scieloorg/scielo-sushi-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scieloorg%2Fscielo-sushi-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28214413,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2026-01-05T02:00:06.358Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-05T06:02:39.059Z","updated_at":"2026-01-05T06:04:08.257Z","avatar_url":"https://github.com/scieloorg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SciELO SUSHI API\nThe SciELO SUSHI API is a service that provides usage data for SciELO journals. To help users utilize the API, we provide a Jupyter Notebook with examples on how to collect data for a given journal. You can find the notebook here:\n\n[![Abrir no Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/scieloorg/scielo-sushi-api/blob/master/docs/acessos.ipynb)\n\n\n## Setting up Database\n- Create the procedures indicated in api/static/sql/procedures.sql\n\n## Instalation and Running\n_Build_\n```shell script\ndocker build . --tag scieloorg/scielo-sushi-api\n```\n\n_Run_\n```\ndocker run -d \\\n    -p 6543:6543 \\\n    --name scielo-sushi-api \\\n    --env STR_CONNECTION=\"mysql://user:pass@localhost:port/database\" \\\n    --env APPLICATION_URL=\"http://127.0.0.1:6543\" \\\n    scieloorg/scielo-sushi-api \\\n    pserve /app/config.ini\n```\n\n_Environment variables_\n| Variable | Description |\n|-------- | ----------- |\n| `APPLICATION_URL` | Application address |\n| `STR_CONNECTION` | Database string connection |\n\n\n## Routes\n\nURL | Description |\n|----|----|\n| `/status` or `/` | Current status of the SciELO SUSHI API service. |\n| `/reports` | Returns a list of reports supported by the SciELO SUSHI API service. |\n| `/members` | Returns the list of members. |\n| `/reports/cr_j1` | Collection-level usage summarized by Metric_Type. |\n| `/reports/ir_a1` | Item Reports provide a summary of activity related to content at the item level and provide a means of evaluating the impact an item has for an institution’s patrons. |\n| `/reports/tr_j1` | Returns COUNTER 'Journal Requests (Excluding OA_Gold)' [TR_J1], a Standard View of Title Master Report. Reports on usage of non-Gold Open Access journal content as “Total_Item_Requests” and “Unique_Item_Requests”. |\n| `/reports/tr_j4` | This resource returns \"Journal Requests by YOP (Excluding OA_Gold)\" [TR_J4], a Standard View of Title Master Report. Breaks down the usage of non-Gold Open Access journal content by year of publication (YOP) providing counts for the metric types \"Total_Item_Requests\" and \"Unique_Item_Requests\". |\n\n\n### Parameters\n| Name | Reports | Description |\n|------|---------|-------------|\n| `api` | `tr_j1`, and `cr_j1` | Version of the API. It could be `api=v2` for reports `tr_j1` and `cr_j1` or `v1` for all the reports. |\n| `begin_date` | `all` | Usage start date in the form o YYYY-MM or YYYY-MM-DD. |\n| `collection`  | `all` | Collection. |\n| `fmt` | `all` | Output format: `tsv` or `json` (default). |\n| `end_date` | `all` | Usage end date in the form o YYYY-MM or YYYY-MM-DD. |\n| `granularity` | `all` | Optional Report Attribute. Include this parameter to allow usage to be retrieved with a granularity of 'month' (default if omitted) or 'totals'. |\n| `issn` | `ir_a1`, `tr_j1`, and `tr_j4` | ISSN of a Journal. |\n| `pid` | `ir_a1` | PID of an article. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscieloorg%2Fscielo-sushi-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscieloorg%2Fscielo-sushi-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscieloorg%2Fscielo-sushi-api/lists"}